The server side of HEA.
HEA Server Framework
The HEA Server Framework contains shared code for creating HEA microservices.
- Python 3.8
- 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.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
<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, run
pip install -r requirements_dev.txt. Do NOT run
python setup.py develop. It will break your environment.
Run tests with the
pytest command from the project root directory.
Running integration tests
- Install Docker
- On Windows, install pywin32 version >= 223 from https://github.com/mhammond/pywin32/releases. In your venv, make sure that
include-system-site-packagesis set to
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,
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
.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.
python setup.py clean --all sdist bdist_wheelto create the artifacts.
twine upload -r <repository> dist/heaserver-<version>.whl dist/heaserver-<version>.tar.gzto upload to the repository. The repository name has to be defined in a twine configuration file such as
- 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."
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for heaserver-1.0.0a27-py3-none-any.whl