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.5.0
- Added attribute-level permissions.
- Fixed bug in checking equality of AbstractAssociation objects.
Version 1.4.0
- Added "deleted" attribute to the trash module's TrashItem class.
- Added Group class to the person module.
Version 1.3.0
- Added type_display_name attribute to all HEA objects.
Version 1.2.0
- Created AbstractAssociation base class for complex associations between desktop objects.
- Used it for the association between organizations and accounts, and volumes and accounts.
Version 1.1.1
- Documented DesktopObject.get_permissions, and fixed an issue where it returned the CHECK_DYNAMIC permission (it) should replace CHECK_DYNAMIC with any dynamically computed permissions).
Version 1.1.0
- Added APIs for generating Person objects representing system users.
- Added system|aws user.
- Added source module with system source names (previously was only in heaserver).
Version 1.0.2
- More performance improvements converting to/from a HEAObject and a dictionary.
Version 1.0.1
- Performance improvements converting from a HEAObject to a dictionary.
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.
- Create a virtualenv environment using the
python -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/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 bypip install -r requirements_dev.txt
. Do NOT runpython 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.
Project 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.5.0.tar.gz
(57.0 kB
view hashes)
Built Distribution
heaobject-1.5.0-py3-none-any.whl
(66.0 kB
view hashes)
Close
Hashes for heaobject-1.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5993a7a3b442cafff3f227335ace1188e6856af093dd3cdbf5f239343ffc313c |
|
MD5 | 1f6a8d2e77005577fc1e75a2f0b438f4 |
|
BLAKE2b-256 | 7e0f245e072cd53345f42ac50d36d22b6c27903ffca21c0e6a5eea3a0fe1237b |