Configuration d'un environnement de développement¶
Contribuer à BeeWare nécessite la mise en place d'un environnement de développement.
Conditions préalables¶
Vous devrez installer les prérequis suivants.
BeeWare nécessite Python 3.10+. Vous aurez
également besoin d'une méthode pour gérer les environnements virtuels (comme
venv).
Vous pouvez vérifier la version de Python que vous avez installée en exécutant :
$ python3 --version
Si plusieurs versions de Python sont installées, vous devrez peut-être remplacer
python3 par un numéro de version spécifique (par exemple, python{{ récent_python_version }}).
Nous recommandons d'éviter les versions de Python récemment publiées (c'est-à-dire les versions qui ont un numéro de micro-version ".0" ou ".1", comme par exemple, 3.14.0). En effet, les outils nécessaires au support de Python sur macOS ne sont généralement pas disponibles pour les versions stables de Python récemment publiées.
BeeWare nécessite Python 3.10+. Vous aurez
également besoin d'une méthode pour gérer les environnements virtuels (comme
venv).
Vous pouvez vérifier la version de Python que vous avez installée en exécutant :
$ python3 --version
Si plusieurs versions de Python sont installées, vous devrez peut-être remplacer
python3 par un numéro de version spécifique (par exemple, python{{ récent_python_version }}).
Nous recommandons d'éviter les versions de Python récemment publiées (c'est-à-dire les versions qui ont un numéro de micro-version ".0" ou ".1", comme par exemple, 3.14.0). En effet, les outils nécessaires au support de Python sur Linux ne sont généralement pas disponibles pour les versions stables de Python récemment publiées.
BeeWare nécessite Python 3.10+. Vous aurez
également besoin d'une méthode pour gérer les environnements virtuels (comme
venv).
Vous pouvez vérifier la version de Python que vous avez installée en exécutant :
C:\...>py -3 --version
Si plusieurs versions de Python sont installées, vous devrez peut-être remplacer
le -3 par un numéro de version spécifique (par exemple, -python{{ récent_python_version }}).
Nous recommandons d'éviter les versions de Python récemment publiées (c'est-à-dire les versions qui ont un numéro de micro-version ".0" ou ".1", comme par exemple, 3.14.0). En effet, les outils nécessaires au support de Python sur Windows ne sont généralement pas disponibles pour les versions stables de Python récemment publiées.
Configurez votre environnement de développement¶
La méthode recommandée pour mettre en place votre environnement de développement pour BeeWare est d'utiliser un environnement virtuel, puis d'installer la version de développement de BeeWare et ses dépendances.
Cloner le dépôt BeeWare.¶
Ensuite, allez sur la page BeeWare sur GitHub, et, si vous ne l'avez pas déjà fait, forker le dépôt dans votre propre compte. Cliquez ensuite sur le bouton "<> Code" de votre fork. Si l'application GitHub desktop est installée sur votre ordinateur, vous pouvez sélectionner "Open with GitHub Desktop" ; sinon, copiez l'URL HTTPS fournie et utilisez-la pour cloner le dépôt sur votre ordinateur à l'aide de la ligne de commande :
Créer un dépôt BeeWare, et ensuite :
$ git clone https://github.com/<your username>/beeware.git
(en remplaçant votre nom d'utilisateur GitHub)
Créer un dépôt BeeWare, et ensuite :
$ git clone https://github.com/<your username>/beeware.git
(en remplaçant votre nom d'utilisateur GitHub)
Créer un dépôt BeeWare, et ensuite :
C:\...>git clone https://github.com/<your username>/beeware.git
(en remplaçant votre nom d'utilisateur GitHub)
Créer un environnement virtuel¶
Pour mettre en place un environnement virtuel et mettre à jour pip, exécutez :
$ cd beeware
$ python3 -m venv .venv
$ source .venv/bin/activate
(.venv) $ python -m pip install -U pip
$ cd beeware
$ python3 -m venv .venv
$ source .venv/bin/activate
(.venv) $ python -m pip install -U pip
C:\...>cd beeware
C:\...>py -3 -m venv .venv
C:\...>.venv\Scripts\activate
(.venv) $ python -m pip install -U pip
Votre prompt devrait maintenant être précédé du préfixe (.venv).
Installer BeeWare¶
Maintenant que vous avez le code source, vous pouvez faire une editable install de BeeWare dans votre environnement de développement. Exécutez la commande suivante :
(.venv) $ python -m pip install -U -e . --group dev
(.venv) $ python -m pip install -U -e . --group dev
(.venv) C:\...>python -m pip install -U -e . --group dev
Activer la pré-commission¶
BeeWare utilise un outil appelé pre-commit pour identifier les problèmes simples et standardiser le formatage du code. Pour ce faire, il installe un hook git qui exécute automatiquement une série de linters de code avant de finaliser tout commit git. Pour activer pre-commit, exécutez :
(.venv) $ pre-commit install
pre-commit installed at .git/hooks/pre-commit
(.venv) $ pre-commit install
pre-commit installed at .git/hooks/pre-commit
(.venv) C:\...>pre-commit install
pre-commit installed at .git/hooks/pre-commit
Vous êtes maintenant prêt à pirater BeeWare !