HEA Server Framework

Research Informatics Shared Resource, Huntsman Cancer Institute, Salt Lake City, UT

The HEA Server Framework contains shared code for creating HEA microservices.

Version 1

Initial release.

Runtime requirements

Python 3.8

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.8: Download and install Python 3.8 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 -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.

Running integration tests

Install Docker
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. Then install the testcontainers package from pip.

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 -SNAPSHOT.

Version tags in git

Version tags should follow the format heaserver-<version>, for example, heaserver-1.0.0.

Uploading to an index server

You will need a custom index server such as devpi to upload HEA component releases so that HEA components can depend on each other. You will need to configure pip to use the custom index server instead of the usual Pypi.

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. Artifacts uploaded to the staging index can be overwritten. Artifacts uploaded to stable cannot. Thus, also use staging to upload numbered releases, verify the uploaded packages, and then upload to stable.

From the project's root directory:

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.
Run python setup.py clean --all sdist bdist_wheel to create the artifacts.
Run twine upload -r <repository> dist/heaserver-<version>.whl dist/heaserver-<version>.tar.gz to upload to the repository. The repository name has to be defined in a twine configuration file such as $HOME/.pypirc.
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."

Release files for heaserver 1.0.0a21

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for heaserver 1.0.0a21
File	Size	Uploaded
heaserver-1.0.0a21.tar.gz	38.7 kB	Jun 24, 2021	Details

Built distribution (wheel)

Table of built distributions (wheels) for heaserver 1.0.0a21
File	Interpreter	ABI	Platform	Reset
heaserver-1.0.0a21-py3-none-any.whl 54.2 kB Jun 24, 2021	Python 3	none	any	Details

Total release size: 92.9 kB

Release files / heaserver-1.0.0a21.tar.gz

Download URL	heaserver-1.0.0a21.tar.gz
Size	38.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`2860401f5f5fc3ebee21a85dead3150e91d00e6abaa0ab045a267cf18eecb476`
BLAKE2b-256 checksum How to use checksums	`2d2456027c4d2cc985ba2cba16f10e1534d485b05fcb92b62eb1bef8010c6a09`
Upload date	Jun 24, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.3.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.3`

Release files / heaserver-1.0.0a21-py3-none-any.whl

Download URL	heaserver-1.0.0a21-py3-none-any.whl
Size	54.2 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`4ad3902ec7a5c51a44b2ea6368ba1451fbecd2dc5438fd2537c3e473e2761124`
BLAKE2b-256 checksum How to use checksums	`90af428747b51e23fb6884fba0484edd351c8b922eb2e22314ebd9f907606e7d`
Upload date	Jun 24, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.3.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.3`