development.md

# Development

DAN uses different tools during its development.

## Linter

Code syntax is analyzed before submitting the code.

To run the linter tools suite you may use [pre-commit](https://pre-commit.com).

```shell
pip install pre-commit
pre-commit run -a
```

## Run tests

Tests are executed with [tox](https://tox.wiki) using [pytest](https://pytest.org).

```shell
pip install tox
tox
```

To recreate tox virtual environment (e.g. a dependencies update), you may run `tox -r`.

## Update documentation

Documentation is built with [MkDocs](https://www.mkdocs.org/).

```shell
pip install -r doc-requirements.txt
mkdocs serve
```

You can then write in Markdown in the relevant `docs/*.md` files, and see live output on http://localhost:8000.