Developer setup

Prerequisites

Before starting, install the following tools:

• Python 3.8 or later
• Pip package manager

For more information on these tools, see the public documentation on Python or Pip

Development can be done on Windows, macOS, and Linux.

Installation

From the root of your cloned repo, generate a virtual environment with a specific version of python.

Windows

python -m venv .env
.env\Scripts\activate.bat

Linux / MacOS

python3 -m venv .env
. ./.env/bin/activate

Next install the package in developer mode and any necessary development packages.

pip install -e .
pip install -r requirements.txt

Validation

You can run local validation including testing and linting using the provided scripts.

Windows

scripts\verify.bat

Linux / MacOS

./scripts/verify

The above can take the following optional arguments to just run specific portions of the validation:

• lint
• tests

e.g.

./scripts/verify lint

To run a more fuller validation across all supported python versions run tox.

tox

If needed, configure the paths to the relevant python installations for tox as follows.

set TOX_DISCOVER=C:\Applications\miniconda3\envs\py39\python.exe

VS Code Extensions

If you are using VS Code, it is recommended you install two extensions (ext install <name>):

• python
• code-spell-checker

Keep the project dictionary up to date by adding exclusions when running spell check.

For different virtual environments, it is also important to update the workspace Python interpreter. Select an interpreter by running the Python: Select Workspace Interpreter command.

Conventions

Before submitting any pull requests for merging, be sure to review the requirements and suggestions outlined in the coding conventions documentation.