Skip to content

Commit 544d32a

Browse files
committed
use uv instead of poetry
1 parent ee1bf2f commit 544d32a

4 files changed

Lines changed: 31 additions & 496 deletions

File tree

.pre-commit-config.yaml

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,3 @@ repos:
1010
hooks:
1111
- id: check-merge-conflict
1212
- id: mixed-line-ending
13-
#- repo: https://github.com/pycqa/bandit
14-
# rev: 1.7.4
15-
# hooks:
16-
# - id: bandit
17-
# exclude: tests/
18-
- repo: https://github.com/Lucas-C/pre-commit-hooks-safety
19-
rev: v1.3.1
20-
hooks:
21-
- id: python-safety-dependencies-check

README.md

Lines changed: 15 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -5,57 +5,31 @@ documentation.
55

66
# Contributing
77

8-
## Installer Poetry
98

10-
Plusieurs [méthodes d'installation](https://python-poetry.org/docs/#installation) sont décrites dans la documentation de poetry dont:
9+
## Installation
1110

12-
- avec pipx
13-
- avec l'installateur officiel
11+
- [Installation de Python](#installation-de-python)
1412

15-
Chaque méthode a ses avantages et inconvénients. Par exemple, la méthode pipx nécessite d'installer pipx au préable, l'installateur officiel utilise curl pour télécharger un script qui doit ensuite être exécuté et comporte des instructions spécifiques pour la completion des commandes poetry selon le shell utilisé (bash, zsh, etc...).
13+
Ce projet utilise [uv](https://docs.astral.sh/uv/) pour la gestion des dépendances Python. Il est préréquis pour l'installation de ce projet.
1614

17-
L'avantage de pipx est que l'installation de pipx est documentée pour linux, windows et macos. D'autre part, les outils installées avec pipx bénéficient d'un environment d'exécution isolé, ce qui est permet de fiabiliser leur fonctionnement. Finalement, l'installation de poetry, voire d'autres outils est relativement simple avec pipx.
15+
Une fois installé, il suffit de lancer la commande suivante pour installer la version de Python adéquate, créer un environnement virtuel et installer les dépendances du projet.
1816

19-
Cependant, libre à toi d'utiliser la méthode qui te convient le mieux ! Quelque soit la méthode choisie, il est important de ne pas installer poetry dans l'environnement virtuel qui sera créé un peu plus tard dans ce README pour les dépendances de la base de code de ce repo git.
17+
```bash
18+
uv sync
19+
```
2020

21-
### Installation de Poetry avec pipx
21+
A l'usage, si vous utilisez VSCode, l'environnement virtuel sera automatiquement activé lorsque vous ouvrirez le projet. Sinon, il suffit de l'activer manuellement avec la commande suivante :
2222

23-
Suivre les instructions pour [installer pipx](https://pipx.pypa.io/stable/#install-pipx) selon ta plateforme (linux, windows, etc...)
23+
```bash
24+
source .venv/bin/activate
25+
```
2426

25-
Par exemple pour Ubuntu 23.04+:
27+
Ou alors, utilisez la commande `uv run ...` (au lieu de `python ...`) pour lancer un script Python. Par exemple:
2628

27-
sudo apt update
28-
sudo apt install pipx
29-
pipx ensurepath
29+
```bash
30+
uv run pipelines/run.py run build_database
31+
```
3032

31-
[Installer Poetry avec pipx](https://python-poetry.org/docs/#installing-with-pipx):
32-
33-
pipx install poetry
34-
35-
### Installation de Poetry avec l'installateur officiel
36-
37-
L'installation avec l'installateur officiel nécessitant quelques étapes supplémentaires,
38-
se référer à la [documentation officielle](https://python-poetry.org/docs/#installing-with-the-official-installer).
39-
40-
## Utiliser un venv python
41-
42-
python3 -m venv .venv
43-
44-
source .venv/bin/activate
45-
46-
## Utiliser Poetry
47-
48-
Installer les dépendances:
49-
50-
poetry install
51-
52-
Ajouter une dépendance:
53-
54-
poetry add pandas
55-
56-
Mettre à jour les dépendances:
57-
58-
poetry update
5933

6034
## Lancer les precommit-hook localement
6135

0 commit comments

Comments
 (0)