https://github.com/chartes/lettres-app
API de l’application Lettres (édition collaborative de correspondances)
Science Score: 13.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
○.zenodo.json file
-
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (6.4%) to scientific vocabulary
Keywords
Repository
API de l’application Lettres (édition collaborative de correspondances)
Statistics
- Stars: 1
- Watchers: 3
- Forks: 2
- Open Issues: 16
- Releases: 0
Topics
Metadata Files
README.md
Lettres
Installation
Dans un répertoire local dédié au projet :
- Cloner le repository GitHub :
bash
git clone https://github.com/chartes/lettres-app.git
Dans le répertoire d'accueil de l'application :
- Exécuter les commandes :
bash
python3 -m venv lettresenv
source lettresenv/bin/activate
pip install -r requirements.txt
- Se rendre dans le sous-répertoire contenant le fichier flaskapp.py et le lancer : ```bash python3 flaskapp.py ```
- Lancer une requête de contrôle : (ex: http://127.0.0.1:5004/ecco/api/1.0/documents?page[size]=2)
Indexation
Installer la version Elasticsearch conforme aux spécifications.
Avec docker cela donne :
bash
docker run --name es-lettres -d -p 9200:9200 -e "discovery.type=single-node" -e "xpack.security.enabled=false" -e "xpack.security.http.ssl.enabled=false" elasticsearch:8.12.1
docker exec es-lettres bash -c "bin/elasticsearch-plugin install analysis-icu"
docker restart es-lettres
Lors de la première indexation, avec une application en local
sur le port 5004, utiliser la commande :
bash
python3 manage.py (--config=<dev/prod>) db-reindex --rebuild --host=http://localhost:5004
Cette commande crée les index de l'application sur la base des mappings
Pour vérifier que les index ont bien été créés:
bash
curl http://localhost:9200/_cat/indices?v
Pour les indexations suivantes, exécuter :
bash
python3 manage.py (--config=<dev/prod>) db-reindex --host=http://localhost:5004
Ajouter un utilisateur
Depuis le répertoire d'accueil de l'application, exécuter :
bash
python3 manage.py add-user --email=<email@email.fr> --username=<username> --password=<userpassword>
Ajouter le flag --admin pour accorder des droits d'administrateur à l'utilisateur.
Documentation :
Lancer le front-end
Owner
- Name: École nationale des chartes
- Login: chartes
- Kind: organization
- Location: 65 rue de Richelieu, 75002 Paris
- Website: http://www.chartes.psl.eu/
- Repositories: 12
- Profile: https://github.com/chartes
Grand établissement d’enseignement supérieur dédié à la recherche historique
GitHub Events
Total
- Push event: 3
Last Year
- Push event: 3
Dependencies
- Flask ==2.1.0
- Flask-Cors ==3.0.10
- Flask-JWT-Extended ==4.3.1
- Flask-Login ==0.6.0
- Flask-Mail ==0.9.1
- Flask-SQLAlchemy ==2.5.1
- Flask-User ==1.0.2.0
- Flask-WTF ==1.0.1
- Jinja2 ==3.1.1
- MarkupSafe ==2.1.1
- PyJWT ==2.3.0
- PyNaCl ==1.5.0
- SQLAlchemy ==1.4.0
- WTForms ==3.0.1
- Werkzeug ==2.1.1
- bcrypt ==3.2.0
- blinker ==1.4
- certifi ==2021.10.8
- cffi ==1.15.0
- charset-normalizer ==2.0.12
- click ==8.1.2
- cryptography ==36.0.2
- dnspython ==2.2.1
- elastic-transport ==8.1.1
- elasticsearch ==6.3.1
- email-validator ==1.1.3
- greenlet ==1.1.2
- idna ==3.3
- importlib-metadata ==4.11.3
- itsdangerous ==2.1.2
- paramiko ==2.10.3
- passlib ==1.7.4
- pycparser ==2.21
- pysftp ==0.2.9
- python-dotenv ==0.20.0
- requests ==2.27.1
- six ==1.16.0
- urllib3 ==1.26.9
- zipp ==3.8.0