Metadata-Version: 2.4
Name: grc-macronizer
Version: 1.3.0
Summary: A macronizer for Ancient Greek
Author-email: Albin Ruben Johannes Thörn Cleland <albin.thorn_cleland@klass.lu.se>
License-Expression: MIT
Project-URL: Homepage, https://github.com/Urdatorn/grc_macronizer
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Text Processing :: Linguistic
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Requires-Python: ==3.12.*
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: grc_utils==0.2.0
Requires-Dist: spacy<3.8.0,>=3.7.4
Requires-Dist: grc_odycy_joint_trf==0.7.0
Requires-Dist: lxml
Requires-Dist: tqdm>=4.65.0
Requires-Dist: xxhash
Provides-Extra: dev
Dynamic: license-file

# A Macronizer for Ancient Greek

<img src="docs/media/macronizer.gif" width="300">

A macronizer geared towards batch macronizing corpora with machine-friendly markup, avoiding combining diacritics and everything that doesn't render in standard IDE and terminal fonts unless specifically asked for.

*Installation:*
- Create a virtual environment with Python 3.12. Nothing will work if you don't get this step right!
- After having initialized your venv, activate it and install the right version of spaCy, the dependency of odyCy, with `pip install spacy>=3.7.4,<3.8.0`.
- Navigate to `external/grc_odycy_joint_trf` and install odyCy locally with `pip install grc_odycy_joint_trf`, while making sure that you are still in the venv with Python 3.12 you created earlier. 
- Install the submodule `grc-utils` with `cd grc-utils` and `pip install .`.

And that's it! Start macronizing by running the notebook [here](macronize.ipynb).

If you have a plain text file you want to macronize, you can run it with `python main.py input_file output_file`.

Note that if you have a newer spaCy pipeline for Ancient Greek, it is easy to substitute it for odyCy. Indeed, the rest of the software has no legacy dependencies and should run with the latest python. 

# License
