DEVELOP.rst

Traits Futures: for developers

These instructions are aimed at developers working with Traits Futures.

Getting started

You'll need a Python 3 environment for development. Any environment using Python >= 3.8 will do. For example, you could create and activate a new venv using something like:

python3.10 -m venv ../traits-futures && source ../traits-futures/bin/activate

Adjust the venv name and location to your taste.

To install the package into the current environment, in editable mode, do:

pip install -e .

To run tests, do:

python -m unittest

To run a style check:

python -m pip install -r style-requirements.txt
python -m flake8
python -m isort . --check --diff
python -m isort docs/source/guide/examples --check --diff
python -m black . --check --diff

To build the documentation:

python -m pip install -r docs/requirements.txt
python -m pip install .
cd docs
python -m sphinx -b html -d doctrees source build