Skip to content
Snippets Groups Projects
Commit f86f76e4 authored by Eliott Sammier's avatar Eliott Sammier
Browse files

Improve README to encourage using the CLI tool

parent 6f314a35
Branches
No related tags found
2 merge requests!4Main,!1Main
# Scripts d'extraction Macao # Extraction et conversion de MACAO
## Dépendances
- **Python 3.11** ou supérieur
- **Java 11** ou supérieur (pour la phase d'export qui utilise [Corese-Python](https://github.com/Wimmics/corese/blob/master/docs/corese-python/Corese-library%20with%20Python.md) via Py4j)
## Setup
> ℹ️ **Le script wrapper `mcli` fournit des commandes dédiées pour initialiser l'environnement et lancer les extracteurs. Sa documentation est sur la page de wiki [Extraction et CLI](https://gitlab.tetras-libre.fr/macao/macao-legacy/-/wikis/Extraction-et-CLI).**
**Le reste de ce README décrit la méthode manuelle.**
## Setup Python
Le script `setup.sh` se charge d'initialiser l'environnement Python Le script `setup.sh` se charge d'initialiser l'environnement Python
```sh ```sh
./setup.sh ./setup.sh
``` ```
Ensuite pour chaque shell, il est nécessaire de `source venv/bin/activate` avant Ensuite pour chaque shell, il est nécessaire d'activer l'environnement avec `source venv/bin/activate`.
de pouvoir lancer Python.
```sh
python src/main.py
```
`main.py` est le point d'entrée du processus de conversion complet, qui produit une arborescence de fichiers pour Macao-Hugo. Chacune des trois phases de conversion peut aussi être lancée séparément : `main.py` est le point d'entrée du processus de conversion complet, qui produit une arborescence de fichiers pour Macao-Hugo. Chacune des trois phases de conversion peut aussi être lancée séparément :
- `extract.py` -> Extraction des contenus textuels MACAO vers une représentation RDF/Turtle - `extract.py` -> Extraction des contenus textuels MACAO vers une représentation RDF/Turtle
- `transform.py` -> Transformation, notamment inférence sur RDFS, nettoyage HTML, identification des ressources liées (images, Flash...) - `transform.py` -> Transformation, notamment inférence sur RDFS, nettoyage HTML, identification des ressources liées (images, Flash...)
- `export.py` -> Export vers le format Hugo+SurveyJS - `export.py` -> Export vers le format Hugo+SurveyJS
Ces points d'entrée ne prennent pas d'arguments mais dépendent de quelques variables d'environnement. L'outil [`mcli`](../../mcli) s'en occupe, voir sa documentation sur le [wiki](https://gitlab.tetras-libre.fr/macao/macao-legacy/-/wikis/Extraction-et-CLI) (notamment la commande `setup-debug` qui permet de préparer un fichier `.env` pour les outils externes).
### Dépendances externes Ces points d'entrée ne prennent pas d'arguments mais dépendent de quelques variables d'environnement. L'outil [`mcli`](../../mcli) s'en occuper, notamment avec la commande `setup-debug` qui permet de préparer un fichier `.env` pour les outils externes (IDE, debuggers...).
La phase d'export utilise [Corese-Python](https://github.com/Wimmics/corese/blob/master/docs/corese-python/Corese-library%20with%20Python.md) via Py4j, et nécessite donc un environnement **Java 11**.
## Protégé ## Protégé
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment