# HEA Keychain
[Research Informatics Shared Resource](https://risr.hci.utah.edu), [Huntsman Cancer Institute](https://hci.utah.edu),
Salt Lake City, UT
The HEA server Keychain is a service for managing laboratory and user credentials.
## Version 1.2.0
* Display type display name in properties card.
## Version 1.1.0
* Pass desktop object permissions back to clients.
* Return type_display_name attribute from GET calls.
## Version 1.0.3
* Improved performance.
## Version 1.0.2
* Added endpoint and links for generating an AWS CLI .aws/credentials file.
## 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 or 3.11: Download and install Python 3.10 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`.
### 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-keychains-<version>`, for example, `heaserver-keychains-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-keychain",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "heaserver-keychain, 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/69/19/07ba206106efdcd16f07437baa4656f26c64bff7ee012fb11c5dbdf299c4/heaserver_keychain-1.2.0.tar.gz",
"platform": null,
"description": "# HEA Keychain\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 Keychain is a service for managing laboratory and user credentials.\r\n\r\n## Version 1.2.0\r\n* Display type display name in properties card.\r\n\r\n## Version 1.1.0\r\n* Pass desktop object permissions back to clients.\r\n* Return type_display_name attribute from GET calls.\r\n\r\n## Version 1.0.3\r\n* Improved performance.\r\n\r\n## Version 1.0.2\r\n* Added endpoint and links for generating an AWS CLI .aws/credentials file.\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 or 3.11: Download and install Python 3.10 from https://www.python.org, and select the options to install \r\nfor all users 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### 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-keychains-<version>`, for example, `heaserver-keychains-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": "a service for managing laboratory credentials",
"version": "1.2.0",
"project_urls": {
"Homepage": "https://risr.hci.utah.edu"
},
"split_keywords": [
"heaserver-keychain",
" microservice",
" healthcare",
" cancer",
" research",
" informatics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a51f902a7835c015f7777162a31ac665cd8cdf037f8f27212727126409550139",
"md5": "0e560c3d9a4541625fc4a71c63ecf319",
"sha256": "2ef84bde6fe1c192f5668f8fa4da79738b25468d906cfaf04bc42cb6da860d08"
},
"downloads": -1,
"filename": "heaserver_keychain-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0e560c3d9a4541625fc4a71c63ecf319",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 12288,
"upload_time": "2024-05-04T04:34:17",
"upload_time_iso_8601": "2024-05-04T04:34:17.761774Z",
"url": "https://files.pythonhosted.org/packages/a5/1f/902a7835c015f7777162a31ac665cd8cdf037f8f27212727126409550139/heaserver_keychain-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "691907ba206106efdcd16f07437baa4656f26c64bff7ee012fb11c5dbdf299c4",
"md5": "30950fbef8207cdce346e34c58f9fc51",
"sha256": "603d8fa026f5417047e4a31a81434abd0ada2dd59490fe075a319a183eb18611"
},
"downloads": -1,
"filename": "heaserver_keychain-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "30950fbef8207cdce346e34c58f9fc51",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 22288,
"upload_time": "2024-05-04T04:34:19",
"upload_time_iso_8601": "2024-05-04T04:34:19.583609Z",
"url": "https://files.pythonhosted.org/packages/69/19/07ba206106efdcd16f07437baa4656f26c64bff7ee012fb11c5dbdf299c4/heaserver_keychain-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-04 04:34:19",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "heaserver-keychain"
}
JSON