Contributing
Contents
Contributing¶
Developing¶
This project uses black to format code and flake8 for linting. We also support pre-commit to ensure
these have been run. To configure your local environment please install these development dependencies and set up
the commit hooks.
$ pip install black flake8 pre-commit
$ pre-commit install
Textual¶
To develop the textual UI furst install the developer dependencies:
$ pip install textual[dev]
To run the Textual UI in developer mode run:
$ textual run --dev dask_ctl.tui:DaskCtlTUI
Then in a second window run the developer console:
$ textual console
Individual widgets also contain a small demo app for testing which you can invoke directly:
$ textual run --dev dask_ctl/tui/widgets/logo.py
Testing¶
This project uses pytest to run tests and also to test docstring examples.
Install the test dependencies.
$ pip install -r requirements-test.txt
Run the tests.
$ pytest
=== 3 passed in 0.13 seconds ===
Documentation¶
This project uses sphinx to build its documentation.
$ pip install -r docs/requirements_docs.txt
$ sphinx-autobuild docs docs/_build/html
# Visit http://localhost:8000 in your browser