Metadata-Version: 2.4
Name: teklia-newspaper
Version: 0.2.0rc2
Summary: Scripts for FINLAM | Newspaper
Author-email: Teklia <contact@teklia.com>
Maintainer-email: Teklia <contact@teklia.com>
Keywords: python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: Pillow==12.3.0
Requires-Dist: teklia-layout-reader==0.2.6
Requires-Dist: teklia-toolbox==0.3.3
Requires-Dist: tqdm==4.70.0
Requires-Dist: ultralytics==8.4.121
Dynamic: license-file

# FINLAM | Newspaper

Scripts for FINLAM | Newspaper.

This project is licensed under the [AGPL-v3 license](https://www.gnu.org/licenses/agpl-3.0.html).

### 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**](https://pypi.org/project/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.

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

### Run tests

Tests are executed with `tox` 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`.

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