Metadata-Version: 2.4
Name: avar-me
Version: 0.0.1
Summary: Avar language dictionary library and CLI for developers
Project-URL: Homepage, https://python.avar.me
Project-URL: Documentation, https://python.avar.me
Project-URL: Repository, https://github.com/avar-me/python
Project-URL: Issues, https://github.com/avar-me/python/issues
Author-email: "avar.me" <python@avar.me>
License-Expression: MIT
License-File: LICENSE
Keywords: avar,caucasian,dictionary,nlp,translation
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Text Processing :: Linguistic
Requires-Python: >=3.10
Requires-Dist: click>=8.1
Provides-Extra: dev
Requires-Dist: mkdocs-material>=9.5; extra == 'dev'
Requires-Dist: mkdocs>=1.6; extra == 'dev'
Requires-Dist: mkdocstrings[python]>=0.25; extra == 'dev'
Requires-Dist: mypy>=1.10; extra == 'dev'
Requires-Dist: pytest-cov>=5.0; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: ruff>=0.4; extra == 'dev'
Description-Content-Type: text/markdown

# avar-me

Python library and CLI for **Avar language dictionary data** — for parsers, translators, tokenizers, corpora, content systems, and ML pipelines.

- **PyPI**: [`avar-me`](https://pypi.org/project/avar-me/)
- **Docs**: [python.avar.me](https://python.avar.me)
- **Repo**: [github.com/avar-me/python](https://github.com/avar-me/python)

## Install

```bash
pip install avar-me
```

## CLI

```bash
avar normalize "бет1ер"
# бетӏер

avar translate "рахӏат"
# отдых, покой; спокойствие

avar lookup "аб"
avar info
```

## Python API

```python
import avar

avar.normalize("бет1ер")       # → 'бетӏер'
avar.translate("рахӏат")       # → 'отдых, покой; спокойствие'
avar.lookup("а")               # → list[Entry] (homographs supported)
avar.get_dictionary("av-ru")   # → Dictionary
```

## Dictionaries

| Pair   | Status   | File |
|--------|----------|------|
| `av-ru` | available | `data/av-ru.dictionary.jsonl` |
| `ru-av` | planned  | — |

More pairs (`en-av`, `av-en`, `tr-av`, …) will follow the same `{source}-{target}` naming.

## Development

```bash
git clone git@github.com:avar-me/python.git && cd python
python3 -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"
pytest
```

See [CONTRIBUTING.md](CONTRIBUTING.md), [AGENTS.md](AGENTS.md) (for LLM agents), and [VERSIONING.md](VERSIONING.md).

## License

MIT — see [LICENSE](LICENSE). Dictionary data licensing is described in the documentation.
