Pour installer un projet Python local en mode éditable sur macOS, ouvrez le Terminal, déplacez-vous dans le répertoire du projet, créez et activez un environnement virtuel, puis exécutez python -m pip install -e .. Cela lie les imports Python à votre arbre de sources de travail, de sorte que les modifications apportées aux fichiers Python soient disponibles dans de nouvelles sessions d'interpréteur sans réinstallation. Le projet a toujours besoin de métadonnées de packaging, et le comportement éditable exact dépend de son backend de build.

Ce que fait une installation éditable

Une installation standard place le projet dans l'environnement Python sélectionné sous forme de paquet installé. Une installation éditable rend quant à elle les sources situées dans le répertoire de développement accessibles sur le chemin d'importation de Python. Elle est utile lorsque vous modifiez ce projet localement ; cela ne signifie pas pour autant que chaque fichier du projet ou ressource non-Python est automatiquement géré de la même manière. Guide d'installation de projets locaux de pip

Le mode éditable ne fait pas non plus disparaître les modifications de dépendances. pip installe les dépendances déclarées par le projet de manière classique, à moins que vous ne transmettiez --no-deps. Les modifications apportées au code source Python sont généralement visibles dès l'exécution suivante, mais une modification des métadonnées du projet, des scripts en ligne de commande générés ou du code compilé peut nécessiter une réinstallation ou une recompilation. Guide de l'utilisateur pour le packaging Python : Empaqueter et distribuer des projets

Préparer un environnement virtuel sur macOS

Dans le Terminal, placez-vous dans le dossier racine du projet, le répertoire contenant pyproject.toml ou un fichier hérité pris en charge setup.py. La commande cd ci-dessous suppose que le dossier se trouve dans votre répertoire personnel ; mettez le chemin entre guillemets s'il contient des espaces.

cd "$HOME/path/to/my-project"
python3 --version
python3 -m venv .venv
source .venv/bin/activate
python -m pip --version

L'environnement virtuel permet d'isoler les paquets installés de ce projet des autres environnements Python. Après l'activation, python doit faire référence à l'interpréteur de l'environnement, de sorte que l'utilisation de python -m pip associe pip à cet interpréteur. La documentation de Python décrit venv comme un outil permettant de créer des environnements isolés et détaille la commande d'activation pour les shells POSIX, y compris le shell utilisé par défaut dans les configurations actuelles du Terminal macOS. Documentation Python : venv

Si python3 est introuvable, installez ou localisez d'abord un interpréteur Python 3 ; macOS ne garantit pas qu'un Python prêt pour le développement soit disponible sous cette commande. Si le projet spécifie une version de Python prise en charge, utilisez cette version pour créer .venv. Évitez d'installer des paquets dans un Python géré par le système lorsqu'un environnement de projet fait l'affaire.

Installer le projet en mode éditable

Avec l'environnement actif et le Terminal toujours situé à la racine du projet, exécutez :

python -m pip install -e .

Ici, -e signifie éditable (editable) et . désigne le répertoire actuel. pip s'attend à ce qu'un répertoire de projet local contienne pyproject.toml ou setup.py. Les projets modernes déclarent généralement un backend de build dans pyproject.toml ; pip demande à ce backend d'effectuer l'installation éditable. Le backend doit prendre en charge l'interface d'installation éditable pour que cela fonctionne comme prévu. Référence pip install, Interface du système de build de pip

Pour effectuer l'installation depuis un autre répertoire, fournissez son chemin à la place de ., par exemple python -m pip install -e "$HOME/path/to/my-project". Mettre le chemin entre guillemets protège les espaces et les métacaractères du shell. L'installation s'applique à l'environnement Python associé à la commande python que vous avez utilisée.

Confirmer l'environnement et diagnostiquer les erreurs

Consultez la liste des projets installés de pip pour confirmer que le paquet et son emplacement de projet éditable y figurent :

python -m pip list

Démarrez ensuite Python à partir de l'environnement activé et essayez d'importer le paquet à l'aide de son nom d'import documenté. Le nom d'importation peut différer du nom de distribution du projet ; consultez donc le fichier README ou le répertoire du paquet plutôt que de deviner. Si l'importation ne fonctionne que depuis un seul dossier, vérifiez que l'installation pointe vers la racine de projet prévue et que le paquet est configuré pour être détecté par son backend.

Si pip indique que le répertoire ne peut pas être installé, vérifiez que vous vous trouvez bien dans la racine correcte et qu'elle contient pyproject.toml ou setup.py. Si le backend de build rejette le mode éditable, mettez à jour ou configurez le backend du projet conformément à sa documentation ; tous les backends plus anciens ou personnalisés ne prennent pas en charge les installations éditables. Pour un projet moderne avec pyproject.toml, pip utilise le hook éditable PEP 660 du backend. Interface du système de build de pip

Si une modification du projet ajoute des dépendances, des points d'entrée ou modifie les métadonnées, réexécutez python -m pip install -e .. Pour les extensions compilées, exécutez également les étapes de compilation documentées du projet. pip souligne que les installations éditables et les installations classiques peuvent se comporter différemment ; une installation éditable est donc réservée au développement local et ne remplace pas la vérification du processus d'installation standard avant de distribuer un paquet. Guide d'installation de projets locaux de pip

Sources