Package: heaserver-keychain
HEA KeychainResearch Informatics Shared Resource,Huntsman Cancer Institute,
Salt Lake City, UTThe HEA server Keychain is a service for managing laboratory and user credentials.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.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 wheelfollowed bypip 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.VersioningUse semantic versioning as described inhttps://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 gitVersion tags should follow the formatheaserver-keychains-<version>, for example,heaserver-keychains-1.0.0.Uploading to an index serverThe 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:For numbered releases, remove.devfrom 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.Runpython setup.py clean --all sdist bdist_wheelto create the artifacts.Runtwine 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.For numbered releases, increment the version number in setup.py, append.devto it, and commit to version
control with a commit message like, "Prepare for next development iteration."