Djalim Simaila
ad26fce0f1
📝 docs(README.md): add usage instructions for manual and poetry setup to improve user understanding ✨ feat(pyproject.toml): add pyproject.toml for poetry dependency management 🔧 chore(requirements.txt): update dependencies, remove unnecessary ones to streamline project setup
34 lines
645 B
Markdown
34 lines
645 B
Markdown
## TL;DR
|
|
|
|
Le module Python Mocodo est un wrapper pour le programme Mocodo. Il peut être utilisé pour faciliter des scripts.
|
|
|
|
On utilise donc le module :
|
|
|
|
```python
|
|
from mocodo.api import mocodo
|
|
```
|
|
|
|
ou être utilisé dans un notebook. Dans ce cas, on utilise :
|
|
|
|
```python
|
|
from mocodo.magic import mocodo
|
|
```
|
|
|
|
L'avantage de ce dernier est qu'il affiche les résultats dans le notebook en plus de générer les fichiers.
|
|
|
|
## Utilisation
|
|
|
|
### Manuellement
|
|
|
|
```sh
|
|
python3 -m venv venv
|
|
source ./venv/bin/activate
|
|
pip install -r requierements.txt
|
|
python3 mocodo_script.py
|
|
```
|
|
|
|
### Poetry
|
|
```sh
|
|
poetry install
|
|
poetry run python3 mocodo_script.py
|
|
``` |