Guide d'Installation d'Artmeta¶

Ce guide vous explique comment installer artmeta, que vous souhaitiez simplement l'utiliser ou contribuer à son développement.

1. Prérequis¶

Python 3.8 ou supérieur
pip (le gestionnaire de paquets de Python)

Pour vérifier votre version de Python, ouvrez un terminal et tapez :

python3 --version

2. Installation pour les Utilisateurs¶

Cette méthode est recommandée pour tous ceux qui souhaitent utiliser artmeta pour leurs projets.

Méthode Recommandée : via un Environnement Virtuel¶

Pourquoi utiliser un environnement virtuel ? Un environnement virtuel est un dossier isolé qui contient une installation de Python spécifique à votre projet. C'est une pratique essentielle qui permet de : - Éviter les conflits entre les dépendances de différents projets. - Garder votre installation Python globale propre. - Travailler sur un projet sans nécessiter de droits administrateur.

Étapes :

Créez un environnement virtuel dans le dossier de votre projet :
```
python3 -m venv venv
```
Activez l'environnement :
- Sur macOS / Linux :
```
source venv/bin/activate
```
- Sur Windows :
```
venv\Scripts\activate
```
  (Votre invite de commande devrait maintenant afficher (venv))
Installez artmeta :
```
pip install artmeta
```
Vérifiez l'installation :
```
artmeta --version
```

Et voilà ! artmeta est prêt à être utilisé dans votre projet.

3. Installation pour les Contributeurs¶

Si vous souhaitez modifier le code source d'artmeta pour corriger un bug ou ajouter une fonctionnalité, suivez ce guide.

Clonez le dépôt Git :

git clone https://plmlab.math.cnrs.fr/nicolas.klutchnikoff/artmeta.git
cd artmeta

Créez et activez un environnement virtuel (voir ci-dessus).
Installez en mode "éditable" : Pour pouvoir tester vos modifications en direct, installez le projet avec l'option -e et les dépendances de développement [dev].
```
pip install -e ".[dev]"
```
- L'option -e (éditable) crée un lien vers vos fichiers sources. Toute modification du code sera immédiatement prise en compte.
- [dev] installe les outils supplémentaires nécessaires pour les tests (pytest) et la documentation (mkdocs).

4. Gestion du Paquet¶

Mettre à jour `artmeta`¶

Si vous avez installé via pip :
```
pip install --upgrade artmeta
```

Si vous avez installé depuis les sources :

cd artmeta
git pull
pip install -e ".[dev]"

Désinstaller `artmeta`¶

pip uninstall artmeta

5. Dépannage (Troubleshooting)¶

Commande `artmeta` non trouvée¶

Si le terminal ne reconnaît pas la commande artmeta après l'installation, essayez ces solutions :

Assurez-vous que votre environnement virtuel est activé.
Vérifiez que le répertoire des scripts de Python est dans votre PATH système.
Utilisez la commande via le module Python : python -m artmeta --version

Problèmes de permission¶

Si vous rencontrez une erreur de permission (souvent sur Linux), n'installez pas avec sudo. La meilleure solution est d'utiliser un environnement virtuel, qui ne nécessite aucun droit particulier.

6. Prochaines Étapes¶

Maintenant qu'artmeta est installé, consultez le Guide Utilisateur pour apprendre à vous en servir !