Metadata-Version: 2.4
Name: latin-lemmatizer
Version: 0.1.2
Summary: Custom tool for Latin text lemmatisation based on the CLTK latin Lemmata data
Project-URL: bugs, https://github.com/mitchopt/latin-lemmatizer/issues
Project-URL: changelog, https://github.com/mitchopt/latin-lemmatizer/releases
Project-URL: documentation, https://mitchopt.github.io/latin-lemmatizer/
Project-URL: homepage, https://github.com/mitchopt/latin-lemmatizer
Author-email: "Mitchell G. Harris" <mitchopt@gmail.com>
Maintainer-email: "Mitchell G. Harris" <mitchopt@gmail.com>
License: MIT
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Typing :: Typed
Requires-Python: >=3.12
Requires-Dist: pyyaml>=6.0.3
Requires-Dist: rich
Requires-Dist: typer
Description-Content-Type: text/markdown

# Latin Lemmatizer

![PyPI version](https://img.shields.io/pypi/v/latin-lemmatizer.svg)

Custom tool for Latin text lemmatisation. Uses an extracted copy of the [CLTK](https://cltk.org/) Latin lemmata data, but does not explicitly depend on CLTK.

* [GitHub](https://github.com/mitchopt/latin-lemmatizer/) | [PyPI](https://pypi.org/project/latin-lemmatizer/) | [Documentation](https://mitchopt.github.io/latin-lemmatizer/)
* Created by [Mitchell G. Harris](https://github.com/mitchopt/) | GitHub [@mitchopt](https://github.com/mitchopt) | PyPI [@mitchopt](https://pypi.org/user/mitchopt/)
* MIT License

## Usage
An --input-parameters option pointing to a yaml file is necessary.
```bash
uv run latin_lemmatizer --input-parameters ./input_parameters.yaml
```
The input parameters yaml **must** specify `text_path` and `output_path` values
```yaml
# ./input_parameters.yaml
text_path: "./data/test.txt"
output_path: "./outputs/test.csv"
```

## Documentation

Documentation is built with [Zensical](https://zensical.org/) and deployed to GitHub Pages.

* **Live site:** https://mitchopt.github.io/latin-lemmatizer/
* **Preview locally:** `just docs-serve` (serves at http://localhost:8000)
* **Build:** `just docs-build`

API documentation is auto-generated from docstrings using [mkdocstrings](https://mkdocstrings.github.io/).

Docs deploy automatically on push to `main` via GitHub Actions. To enable this, go to your repo's Settings > Pages and set the source to **GitHub Actions**.

## Development

To set up for local development:

```bash
# Clone your fork
git clone git@github.com:your_username/latin-lemmatizer.git
cd latin-lemmatizer

# Install in editable mode with live updates
uv tool install --editable .
```

This installs the CLI globally but with live updates - any changes you make to the source code are immediately available when you run `latin_lemmatizer`.

Run tests:

```bash
uv run pytest
```

Run quality checks (format, lint, type check, test):

```bash
just qa
```

## Author

Latin Lemmatizer was created in 2026 by Mitchell G. Harris.

Built with [Cookiecutter](https://github.com/cookiecutter/cookiecutter) and the [audreyfeldroy/cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage) project template.
