# HEA Server AWS Accounts Microservice
[Research Informatics Shared Resource](https://risr.hci.utah.edu), [Huntsman Cancer Institute](https://hci.utah.edu),
Salt Lake City, UT
The HEA Server AWS Accounts Microservice is It manages the AWS account information details.
## Version 1.5.1
* Performance improvements.
## Version 1.5.0
* Added support for Python 3.12.
## Version 1.4.0
* Removed integration tests because they all overlapped with the unit tests.
* Accept the data query parameter for get requests for a speed boost.
## Version 1.3.9
* Dependency upgrades for compatibility with heaserver-keychain 1.5.0.
## Version 1.3.8
* Fixed another /accounts regression when no account ids are passed as query parameters.
## Version 1.3.7
* Stop returning all accounts with an accessible volume; only return the requested accounts.
## Version 1.3.6
* When retrieving /accounts, skip volumes with a null account_id. Fixes crash retrieving accounts.
## Version 1.3.5
* Pull /accounts from volume data rather than trying to get account info from AWS. Helps with performance for users who
have access to lots of accounts.
## Version 1.3.4
* Caching optimizations.
## Version 1.3.3
* Fixed new bucket link.
## Version 1.3.2
* Fixed a caching issue when listing accounts.
* Additional input validation.
## Version 1.3.1
* Avoid timeouts loading accounts, which sporadically caused accounts not to be returned.
## Version 1.3.0
* Present accurate account permissions.
* Added caching for getting accounts list.
## Version 1.2.0
* New /accounts endpoint that returns heaobject.account.AccountView objects.
## Version 1.1.3
* Another attempt at fixing the crash regression.
## Version 1.1.2
* Fixed crash regression.
## Version 1.1.1
* Fixed new bucket form submission.
## Version 1.1.0
* Removed the PUT and DELETE account calls because neither works.
## Version 1.0.8
* Addressed occasional slowdown getting one account.
## Version 1.0.7
* Addressed occasional slowdown getting accounts.
## Version 1.0.6
* Display type display name in properties card, and return the type display name from GET calls.
## Version 1.0.5
* Improved performance getting accounts.
## Version 1.0.4
* Corrected caching issue.
## Version 1.0.3
* Improved error handling when the user lacks authorization for some AWS account information.
## Version 1.0.2
* Avoid a 500 error when retrieving accounts when attempting to access a suspended account.
* AWS account info requests return more complete information.
* Omit shares from the properties template.
## Version 1.0.1
* Improved performance.
## Version 1
Initial release.
## Runtime requirements
* Python 3.10 or 3.11.
## Development environment
### Build requirements
* Any development environment is fine.
* On Windows, you also will need:
* Build Tools for Visual Studio 2019, found at https://visualstudio.microsoft.com/downloads/. Select the C++ tools.
* git, found at https://git-scm.com/download/win.
* On Mac, Xcode or the command line developer tools is required, found in the Apple Store app.
* Python 3.10, 3.11, or 3.12: Download and install it from https://www.python.org, and select the options to install for all
users and add Python to your environment variables. The install for all users option will help keep you from
accidentally installing packages into your Python installation's site-packages directory instead of to your virtualenv
environment, described below.
* Create a virtualenv environment using the `python -m venv <venv_directory>` command, substituting `<venv_directory>`
with the directory name of your virtual environment. Run `source <venv_directory>/bin/activate` (or `<venv_directory>/Scripts/activate` on Windows) to activate the virtual
environment. You will need to activate the virtualenv every time before starting work, or your IDE may be able to do
this for you automatically. **Note that PyCharm will do this for you, but you have to create a new Terminal panel
after you newly configure a project with your virtualenv.**
* From the project's root directory, and using the activated virtualenv, run `pip install wheel` followed by
`pip install -r requirements_dev.txt`. **Do NOT run `python setup.py develop`. It will break your environment.**
### Running tests
Run tests with the `pytest` command from the project root directory. To improve performance, run tests in multiple
processes with `pytest -n auto`.
### Testing using Swagger
Run `python ./run-swaggerui.py` and open up http://locahost:8080/docs in your web browser to get a UI for making REST
API calls.
### Versioning
Use semantic versioning as described in
https://packaging.python.org/guides/distributing-packages-using-setuptools/#choosing-a-versioning-scheme. In addition,
while development is underway, the version should be the next version number suffixed by `.dev`.
### Version tags in git
Version tags should follow the format `heaserver-awsaccounts-<version>`, for example, `heaserver-awsaccounts-1.0.0`.
### Uploading to an index server
The following instructions assume separate stable and staging indexes. Numbered releases, including alphas and betas, go
into the stable index. Snapshots of works in progress go into the staging index. Thus, use staging to upload numbered
releases, verify the uploaded packages, and then upload to stable.
From the project's root directory:
1. For numbered releases, remove `.dev` from the version number in setup.py, tag it in git to indicate a release,
and commit to version control. Skip this step for developer snapshot releases.
2. Run `python setup.py clean --all sdist bdist_wheel` to create the artifacts.
3. Run `twine upload -r <repository> dist/<wheel-filename> dist/<tarball-filename>` to upload to the
repository. The repository name has to be defined in a twine configuration file such as `$HOME/.pypirc`.
4. For numbered releases, increment the version number in setup.py, append `.dev` to it, and commit to version
control with a commit message like, "Prepare for next development iteration."
Raw data
{
"_id": null,
"home_page": "https://risr.hci.utah.edu",
"name": "heaserver-accounts",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "heaserver-accounts, microservice, healthcare, cancer, research, informatics",
"author": "Research Informatics Shared Resource, Huntsman Cancer Institute, Salt Lake City, UT",
"author_email": "Andrew.Post@hci.utah.edu",
"download_url": "https://files.pythonhosted.org/packages/2b/5c/2dd20a561239d7fecad9b4905668b6d707b51a4bd97097fae394ab7ccdf6/heaserver_accounts-1.5.1.tar.gz",
"platform": null,
"description": "# HEA Server AWS Accounts Microservice\r\n[Research Informatics Shared Resource](https://risr.hci.utah.edu), [Huntsman Cancer Institute](https://hci.utah.edu),\r\nSalt Lake City, UT\r\n\r\nThe HEA Server AWS Accounts Microservice is It manages the AWS account information details.\r\n\r\n## Version 1.5.1\r\n* Performance improvements.\r\n\r\n## Version 1.5.0\r\n* Added support for Python 3.12.\r\n\r\n## Version 1.4.0\r\n* Removed integration tests because they all overlapped with the unit tests.\r\n* Accept the data query parameter for get requests for a speed boost.\r\n\r\n## Version 1.3.9\r\n* Dependency upgrades for compatibility with heaserver-keychain 1.5.0.\r\n\r\n## Version 1.3.8\r\n* Fixed another /accounts regression when no account ids are passed as query parameters.\r\n\r\n## Version 1.3.7\r\n* Stop returning all accounts with an accessible volume; only return the requested accounts.\r\n\r\n## Version 1.3.6\r\n* When retrieving /accounts, skip volumes with a null account_id. Fixes crash retrieving accounts.\r\n\r\n## Version 1.3.5\r\n* Pull /accounts from volume data rather than trying to get account info from AWS. Helps with performance for users who\r\nhave access to lots of accounts.\r\n\r\n## Version 1.3.4\r\n* Caching optimizations.\r\n\r\n## Version 1.3.3\r\n* Fixed new bucket link.\r\n\r\n## Version 1.3.2\r\n* Fixed a caching issue when listing accounts.\r\n* Additional input validation.\r\n\r\n## Version 1.3.1\r\n* Avoid timeouts loading accounts, which sporadically caused accounts not to be returned.\r\n\r\n## Version 1.3.0\r\n* Present accurate account permissions.\r\n* Added caching for getting accounts list.\r\n\r\n## Version 1.2.0\r\n* New /accounts endpoint that returns heaobject.account.AccountView objects.\r\n\r\n## Version 1.1.3\r\n* Another attempt at fixing the crash regression.\r\n\r\n## Version 1.1.2\r\n* Fixed crash regression.\r\n\r\n## Version 1.1.1\r\n* Fixed new bucket form submission.\r\n\r\n## Version 1.1.0\r\n* Removed the PUT and DELETE account calls because neither works.\r\n\r\n## Version 1.0.8\r\n* Addressed occasional slowdown getting one account.\r\n\r\n## Version 1.0.7\r\n* Addressed occasional slowdown getting accounts.\r\n\r\n## Version 1.0.6\r\n* Display type display name in properties card, and return the type display name from GET calls.\r\n\r\n## Version 1.0.5\r\n* Improved performance getting accounts.\r\n\r\n## Version 1.0.4\r\n* Corrected caching issue.\r\n\r\n## Version 1.0.3\r\n* Improved error handling when the user lacks authorization for some AWS account information.\r\n\r\n## Version 1.0.2\r\n* Avoid a 500 error when retrieving accounts when attempting to access a suspended account.\r\n* AWS account info requests return more complete information.\r\n* Omit shares from the properties template.\r\n\r\n## Version 1.0.1\r\n* Improved performance.\r\n\r\n## Version 1\r\nInitial release.\r\n\r\n## Runtime requirements\r\n* Python 3.10 or 3.11.\r\n\r\n## Development environment\r\n\r\n### Build requirements\r\n* Any development environment is fine.\r\n* On Windows, you also will need:\r\n * Build Tools for Visual Studio 2019, found at https://visualstudio.microsoft.com/downloads/. Select the C++ tools.\r\n * git, found at https://git-scm.com/download/win.\r\n* On Mac, Xcode or the command line developer tools is required, found in the Apple Store app.\r\n* Python 3.10, 3.11, or 3.12: Download and install it from https://www.python.org, and select the options to install for all\r\nusers and add Python to your environment variables. The install for all users option will help keep you from\r\naccidentally installing packages into your Python installation's site-packages directory instead of to your virtualenv\r\nenvironment, described below.\r\n* Create a virtualenv environment using the `python -m venv <venv_directory>` command, substituting `<venv_directory>`\r\nwith the directory name of your virtual environment. Run `source <venv_directory>/bin/activate` (or `<venv_directory>/Scripts/activate` on Windows) to activate the virtual\r\nenvironment. You will need to activate the virtualenv every time before starting work, or your IDE may be able to do\r\nthis for you automatically. **Note that PyCharm will do this for you, but you have to create a new Terminal panel\r\nafter you newly configure a project with your virtualenv.**\r\n* From the project's root directory, and using the activated virtualenv, run `pip install wheel` followed by\r\n `pip install -r requirements_dev.txt`. **Do NOT run `python setup.py develop`. It will break your environment.**\r\n\r\n### Running tests\r\nRun tests with the `pytest` command from the project root directory. To improve performance, run tests in multiple\r\nprocesses with `pytest -n auto`.\r\n\r\n### Testing using Swagger\r\nRun `python ./run-swaggerui.py` and open up http://locahost:8080/docs in your web browser to get a UI for making REST\r\nAPI calls.\r\n\r\n### Versioning\r\nUse semantic versioning as described in\r\nhttps://packaging.python.org/guides/distributing-packages-using-setuptools/#choosing-a-versioning-scheme. In addition,\r\nwhile development is underway, the version should be the next version number suffixed by `.dev`.\r\n\r\n### Version tags in git\r\nVersion tags should follow the format `heaserver-awsaccounts-<version>`, for example, `heaserver-awsaccounts-1.0.0`.\r\n\r\n### Uploading to an index server\r\nThe following instructions assume separate stable and staging indexes. Numbered releases, including alphas and betas, go\r\ninto the stable index. Snapshots of works in progress go into the staging index. Thus, use staging to upload numbered\r\nreleases, verify the uploaded packages, and then upload to stable.\r\n\r\nFrom the project's root directory:\r\n1. For numbered releases, remove `.dev` from the version number in setup.py, tag it in git to indicate a release,\r\nand commit to version control. Skip this step for developer snapshot releases.\r\n2. Run `python setup.py clean --all sdist bdist_wheel` to create the artifacts.\r\n3. Run `twine upload -r <repository> dist/<wheel-filename> dist/<tarball-filename>` to upload to the\r\n repository. The repository name has to be defined in a twine configuration file such as `$HOME/.pypirc`.\r\n4. For numbered releases, increment the version number in setup.py, append `.dev` to it, and commit to version\r\ncontrol with a commit message like, \"Prepare for next development iteration.\"\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Manages account information",
"version": "1.5.1",
"project_urls": {
"Homepage": "https://risr.hci.utah.edu"
},
"split_keywords": [
"heaserver-accounts",
" microservice",
" healthcare",
" cancer",
" research",
" informatics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fa3926f8473e6f1f1dbc4cb943e0fd76e911bdc61fc60f6dc0939ac4fa775915",
"md5": "6273f4d6799db31864cb088ac9e3fbff",
"sha256": "1b08ef0ab6d16ae47328fdac372a92eeba116f5c33b11863320ad921e67e8c65"
},
"downloads": -1,
"filename": "heaserver_accounts-1.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6273f4d6799db31864cb088ac9e3fbff",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 19664,
"upload_time": "2024-12-04T00:45:33",
"upload_time_iso_8601": "2024-12-04T00:45:33.801984Z",
"url": "https://files.pythonhosted.org/packages/fa/39/26f8473e6f1f1dbc4cb943e0fd76e911bdc61fc60f6dc0939ac4fa775915/heaserver_accounts-1.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2b5c2dd20a561239d7fecad9b4905668b6d707b51a4bd97097fae394ab7ccdf6",
"md5": "841cc02299f6b909a62f835bcef62726",
"sha256": "967bd5ae54fec5388010a88425b1ec065f4858604e2691b3d3cd01a5a85d9bef"
},
"downloads": -1,
"filename": "heaserver_accounts-1.5.1.tar.gz",
"has_sig": false,
"md5_digest": "841cc02299f6b909a62f835bcef62726",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 29126,
"upload_time": "2024-12-04T00:45:35",
"upload_time_iso_8601": "2024-12-04T00:45:35.817547Z",
"url": "https://files.pythonhosted.org/packages/2b/5c/2dd20a561239d7fecad9b4905668b6d707b51a4bd97097fae394ab7ccdf6/heaserver_accounts-1.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-04 00:45:35",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "heaserver-accounts"
}
JSON