Developers

Setup

1. First, you need to fork the GitHub repository.

   Note : always work on a specific branch dedicated to your patch.

2. Then, you could need the Embedded printer DP-EH600 Technical Manual and take a look at the features advancement.

3. Finally, be sure to add/update tests and documentation within your patch.

Testing

Dependencies

Install required packages:

python -m pip install -e '.[tests]'

How to test?

python -m pytest

And you can test printing functions (if you added a styling method, you can add it to this function).

Validating the code

It is important to keep a clean base code. Use tools like flake8 and Pylint.

Dependencies

Install required packages:

python -m pip install -e '.[dev]'

How to validate?

./checks.sh

Documentation

Dependencies

Install required packages:

python -m pip install -e '.[docs]'

How to build?

sphinx-build --color -W -bhtml docs/source docs/output