# HEA Volumes Microservice
[Research Informatics Shared Resource](https://risr.hci.utah.edu), [Huntsman Cancer Institute](https://hci.utah.edu),
Salt Lake City, UT
The HEA Volumes Microservice The HEA volumes service.
## Version 1.3.0
* We now pass the type_display_name property in volume Collection+JSON templates.
* Caching optimizations.
## Version 1.2.0
* Hid some attributes from the heaobject.volume.Volume properties card.
* Added account_id attribute to the heaobject.volume.Volume properties card.
* Removed the type name filter from volume queries. We now use heaobject.account.AccountView ids for the account id
filter.
## Version 1.1.0
* Support filtering volumes by account id and type name.
## Version 1.0.2
* Improved performance.
## 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.
* Upgrade pip to version 21.1.2 or greater with `python -m pip install --upgrade pip`.
* 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 -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`.
### Running integration tests
* Install Docker
* On Windows, install pywin32 version >= 223 from https://github.com/mhammond/pywin32/releases. In your venv, make sure that
`include-system-site-packages` is set to `true`.
### Trying out the APIs
This microservice has Swagger3/OpenAPI support so that you can quickly test the APIs in a web browser. Do the following:
* Install Docker, if it is not installed already.
* Have a heaserver-registry docker image in your Docker cache. You can generate one using the Dockerfile in the
heaserver-registry project.
* Have a heaserver-folders docker image in your Docker cache. You can generate one using the Dockerfile in the
heaserver-folders project.
* Run the `run-swaggerui.py` file in your terminal. This file contains some test objects that are loaded into a MongoDB
Docker container.
* Go to http://127.0.0.1:8080/docs in your web browser.
Once `run-swaggerui.py` is running, you can also access the APIs via `curl` or other tool. For example, in Windows
PowerShell, execute:
```
Invoke-RestMethod -Uri http://localhost:8080/volumes/ -Method GET -Headers @{'accept' = 'application/json'}`
```
In MacOS or Linux, the equivalent command is:
```
curl -X GET http://localhost:8080/volumes/ -H 'accept: application/json'
```
### Packaging and releasing this project
See the [RELEASING.md](RELEASING.md) file for details.
Raw data
{
"_id": null,
"home_page": "https://risr.hci.utah.edu",
"name": "heaserver-volumes",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "heaserver-volumes, 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/2e/d0/8df9dde3905cdc6b06271d4222c60bf3cac06028ce74630d091473c703dd/heaserver_volumes-1.3.0.tar.gz",
"platform": null,
"description": "# HEA Volumes 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 Volumes Microservice The HEA volumes service.\r\n\r\n## Version 1.3.0\r\n* We now pass the type_display_name property in volume Collection+JSON templates.\r\n* Caching optimizations.\r\n\r\n## Version 1.2.0\r\n* Hid some attributes from the heaobject.volume.Volume properties card.\r\n* Added account_id attribute to the heaobject.volume.Volume properties card.\r\n* Removed the type name filter from volume queries. We now use heaobject.account.AccountView ids for the account id\r\nfilter.\r\n\r\n## Version 1.1.0\r\n* Support filtering volumes by account id and type name.\r\n\r\n\r\n## Version 1.0.2\r\n* Improved performance.\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* Upgrade pip to version 21.1.2 or greater with `python -m pip install --upgrade pip`.\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 -r requirements_dev.txt`.\r\n**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### Running integration tests\r\n* Install Docker\r\n* On Windows, install pywin32 version >= 223 from https://github.com/mhammond/pywin32/releases. In your venv, make sure that\r\n`include-system-site-packages` is set to `true`.\r\n\r\n### Trying out the APIs\r\nThis microservice has Swagger3/OpenAPI support so that you can quickly test the APIs in a web browser. Do the following:\r\n* Install Docker, if it is not installed already.\r\n* Have a heaserver-registry docker image in your Docker cache. You can generate one using the Dockerfile in the\r\n heaserver-registry project.\r\n* Have a heaserver-folders docker image in your Docker cache. You can generate one using the Dockerfile in the\r\n heaserver-folders project.\r\n* Run the `run-swaggerui.py` file in your terminal. This file contains some test objects that are loaded into a MongoDB\r\n Docker container.\r\n* Go to http://127.0.0.1:8080/docs in your web browser.\r\n\r\nOnce `run-swaggerui.py` is running, you can also access the APIs via `curl` or other tool. For example, in Windows\r\nPowerShell, execute:\r\n```\r\nInvoke-RestMethod -Uri http://localhost:8080/volumes/ -Method GET -Headers @{'accept' = 'application/json'}`\r\n```\r\nIn MacOS or Linux, the equivalent command is:\r\n```\r\ncurl -X GET http://localhost:8080/volumes/ -H 'accept: application/json'\r\n```\r\n\r\n### Packaging and releasing this project\r\nSee the [RELEASING.md](RELEASING.md) file for details.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "The HEA volumes service",
"version": "1.3.0",
"project_urls": {
"Homepage": "https://risr.hci.utah.edu"
},
"split_keywords": [
"heaserver-volumes",
" microservice",
" healthcare",
" cancer",
" research",
" informatics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1e164b3865b35ca8b63e0a7bd23f11f138b1126b725556e73d742bdeef032317",
"md5": "1cb4310d5c3ec1dc42dd689b772b969a",
"sha256": "f875f3f0edf9a0ead0d49b095ba3bb3476b7eda90defb94c852abad932dd0a89"
},
"downloads": -1,
"filename": "heaserver_volumes-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1cb4310d5c3ec1dc42dd689b772b969a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 13187,
"upload_time": "2024-10-18T22:09:58",
"upload_time_iso_8601": "2024-10-18T22:09:58.917068Z",
"url": "https://files.pythonhosted.org/packages/1e/16/4b3865b35ca8b63e0a7bd23f11f138b1126b725556e73d742bdeef032317/heaserver_volumes-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2ed08df9dde3905cdc6b06271d4222c60bf3cac06028ce74630d091473c703dd",
"md5": "56e8c71d45d93037dadb936442a88e44",
"sha256": "6efde6f13e7d0210ff55ff3a4bbba2b09bb13f38a36c6e4f35a7793f1043a2a6"
},
"downloads": -1,
"filename": "heaserver_volumes-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "56e8c71d45d93037dadb936442a88e44",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 25719,
"upload_time": "2024-10-18T22:10:00",
"upload_time_iso_8601": "2024-10-18T22:10:00.440834Z",
"url": "https://files.pythonhosted.org/packages/2e/d0/8df9dde3905cdc6b06271d4222c60bf3cac06028ce74630d091473c703dd/heaserver_volumes-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-18 22:10:00",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "heaserver-volumes"
}
JSON