1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
|
Contributing
============
Running Tests
-------------
:command:`tox` is used to run tests. It will run :command:`mypy` for type
checking, :command:`pylint` for linting, :command:`pytest` for testing, and
:command:`black` for code formatting.
.. code-block:: shell
$ tox # All python versions
$ tox -e py38 # Python 3.8
$ tox -e py39 # Python 3.9
$ tox -e py310 # Python 3.10
$ tox -e mypy # Mypy Typechecking
$ tox -e pylint # Linting
$ tox -e black # Check Formatting
Code Formatting
---------------
This project uses ``black`` for code formatting.
.. code-block:: shell
$ black . # format all python code
Building Documentation
----------------------
Documentation is built using :command:`sphinx`.
.. code-block:: shell
$ cd docs/
$ make man # Build manpage
Publishing
----------
.. code-block:: shell
$ python3 setup.py sdist bdist_wheel
$ twine check dist/*
$ twine upload dist/*
|
