Welcome! As a Jupyter project, you can follow the Jupyter contributor guide.
Make sure to also follow Project Jupyter's Code of Conduct for a friendly and welcoming collaborative environment.
This package requires Python >= 3.6.
As a Python package, you can set up a development environment by cloning this repo and running:
python3 -m pip install --editable .
from the repo directory.
You can also install the tools we use for testing and development with:
python3 -m pip install -r dev-requirements.txt
We use the pre-commit tool for autoformatting.
You can install and enable it with:
pip install pre-commit
pre-commit install
After doing this, every time you make a commit,
pre-commit will run autoformatting.
If it makes any changes, it'll let you know and you can make the commit again with the autoformatting changes.
After doing a development install, you can run the tests with:
pytest -v
in the repo directory.