Developer install

These instructions will take you through the minimal steps required to get a dev environment setup, so you can run the tests locally.

Clone the repository

First clone the repository locally using Git:

$ git clone git://github.com/DiamondLightSource/hdf5-reader-service.git

Install dependencies

You can choose to either develop on the host machine using a venv (which requires python 3.9 or later) or to run in a container under VSCode

Local virtualenv

$ cd hdf5-reader-service
$ python3 -m venv venv
$ source venv/bin/activate
$ pip install -e '.[dev]'

VSCode devcontainer

$ code hdf5-reader-service
# Click on 'Reopen in Container' when prompted
# Open a new terminal

Note

See the epics-containers documentation for more complex use cases, such as integration with podman.

See what was installed

To see a graph of the python package dependency tree type:

$ pipdeptree

Build and test

Now you have a development environment you can run the tests in a terminal:

$ tox -p

This will run in parallel the following checks:

• Build the docs using sphinx

• Run the tests using pytest

• Run static analysis using mypy

• Run linting using pre-commit