Skip to main content

Data and other classes that are passed into and out of HEA REST APIs.

Project description

HEA Object Library

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

The HEA Object Library contains data and other classes that are passed into and out of HEA REST APIs.

Version 1

Initial release.

Runtime requirements

  • Python 3.8, 3.9, or 3.10.

Development environment

Build requirements

  • Any development environment is fine.
  • On Windows, you also will need:
  • On Mac, Xcode or the command line developer tools is required, found in the Apple Store app.
  • Python 3.10: 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 unit tests

Run tests with the pytest command from the project root directory.

Packaging and releasing this project

See the RELEASING.md file for details.

Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

heaobject-1.0.0a28.tar.gz (28.2 kB view hashes)

Uploaded Source

Built Distribution

heaobject-1.0.0a28-py3-none-any.whl (33.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page