FINLAM | Newspaper

Scripts for FINLAM | Newspaper.

This project is licensed under the AGPL-v3 license.

Development

For development and tests purpose it may be useful to install the project as a editable package with pip.

• Use a virtualenv (e.g. with virtualenvwrapper mkvirtualenv -a . newspaper)
• Install newspaper as a package (e.g. pip install -e .)
• Install pero-ocr from our unpublished fork (this allows to benefit from unreleased commits): pip install pero-ocr@git+https://github.com/EvaBardou/pero-ocr@0.7.0post1

Linter

Code syntax is analyzed before submitting the code.
To run the linter tools suite you may use pre-commit.

pip install pre-commit
pre-commit run -a

Run tests

Tests are executed with tox using pytest.

pip install tox
tox

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

Run a single test module: tox -- <test_path> Run a single test: tox -- <test_path>::<test_function>