[go: nahoru, domu]

Skip to content

hipster-philology/pyrrha

Repository files navigation

Pyrrha

Coverage Status Test library DOI

Pyrrha is a simple Python Flask WebApp to fasten the post-correction of lemmatized and morpho-syntactic tagged corpora.

How to cite

This web application and its maintenance is done by Julien Pilla (@MrGecko) and Thibault Clérice (@ponteineptique). As software is research please cite the software if you use it using the following informations:

@software{thibault_clerice_2019_3524771,
  author       = {Clérice, Thibault and Janès, Juliette and Pilla, Julien and Camps, Jean-Baptiste and Pinche, Ariane and Gille-Levenson, Matthias and Jolivet, Vincent},
  title        = {Pyrrha, A language independant post correction app for POS and lemmatization},
  month        = nov,
  year         = 2024,
  publisher    = {Zenodo},
  version      = {4.0.0},
  doi          = {10.5281/zenodo.2325427},
  url          = {https://doi.org/10.5281/zenodo.2325427}
}

They used Pyrrha

You can find a set of projects and papers that used us in the examples.bib file.

Update the translations

From the root directory, run:

pybabel compile -d translations

Demo

Pandora Post-Correction Editor

Install

Start by cloning the repository, and moving inside the created folder

git clone https://github.com/hipster-philology/pyrrha.git
cd pyrrha/

Create a virtual environment, source it and run

pip install -r requirements.txt
python manage.py db-create

Run

python manage.py run

Creating a new user locally

  1. Run the application
  2. Click register and register. Remember to note the user email you register with.
  3. Stop the application
  4. Run python manage.py edit-user [EMAIL] --confirm-mail --role Administrator or simply python manage.py edit-user [EMAIL] --confirm-mail if you don't want administrator role. Replace [EMAIL] with the mail you used. If you are simply running it for yourself, we would definitely recommend to use the Administrator role though.
  5. Run the application, login and enjoy !

Update the translations

From the root directory, run:

python manage.py translate compile

If you changed the template or variables

python manage.py translate update
# Change the translation and then do
python manage.py translate compile

If you want to add a language

python manage.py translate init fr
python manage.py translate update
python manage.py translate compile

How to contribute

Maintainers

Past maintainers

Contributors

Source

This app is wished to be simple and local at the moment (No User system). But to keep in the abilities to extend and use other systems, we based some of our decisions on https://github.com/hack4impact/flask-base/ and the general structure is following theirs.