Package: heaserver-volumes
HEA Volumes MicroserviceResearch Informatics Shared Resource,Huntsman Cancer Institute,
Salt Lake City, UTThe HEA Volumes Microservice The HEA volumes service.Version 1.0.1Improved performance.Version 1Initial release.Runtime requirementsPython 3.10 or 3.11Development environmentBuild requirementsAny development environment is fine.On Windows, you also will need:Build Tools for Visual Studio 2019, found athttps://visualstudio.microsoft.com/downloads/. Select the C++ tools.git, found athttps://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 fromhttps://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 withpython -m pip install --upgrade pip.Create a virtualenv environment using thepython -m venv <venv_directory>command, substituting<venv_directory>with the directory name of your virtual environment. Runsource <venv_directory>/bin/activate(or<venv_directory>/Scripts/activateon 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, runpip install -r requirements_dev.txt.Do NOT runpython setup.py develop. It will break your environment.Running testsRun tests with thepytestcommand from the project root directory. To improve performance, run tests in multiple
processes withpytest -n auto.Running integration testsInstall DockerOn Windows, install pywin32 version >= 223 fromhttps://github.com/mhammond/pywin32/releases. In your venv, make sure thatinclude-system-site-packagesis set totrue.Trying out the APIsThis 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 therun-swaggerui.pyfile in your terminal. This file contains some test objects that are loaded into a MongoDB
Docker container.Go tohttp://127.0.0.1:8080/docsin your web browser.Oncerun-swaggerui.pyis running, you can also access the APIs viacurlor 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 projectSee theRELEASING.mdfile for details.