To install the package from PyPI:
pip install pdfa_learning
- Make sure you have Python 3.7+ on your platform.
- Install Poetry
- Clone the repository and enter it:
git clone https://github.com/marcofavorito/pdfa-learning.git && cd pdfa-learning
- Set up the Python virtual environment:
poetry shell && poetry install
- Install Graphviz if you want to use the rendering features.
Please have a look at the notebooks/
to see how to use the code.
To run tests: tox
To run only the code tests: tox -e py3.7
To run only the linters:
tox -e flake8
tox -e mypy
tox -e black-check
tox -e isort-check
To build the docs: mkdocs build
To view documentation in a browser: mkdocs serve
and then go to http://localhost:8000
pdfa-learning is released under the GNU General Public License v3.0 or later (GPLv3+).
Copyright 2020 Marco Favorito