Skip to content

Commit

Permalink
chore(dev): Upgrade python to 3.11 (#382)
Browse files Browse the repository at this point in the history
  • Loading branch information
germainlefebvre4 authored Aug 20, 2024
1 parent 147e5d1 commit accb071
Show file tree
Hide file tree
Showing 4 changed files with 587 additions and 546 deletions.
3 changes: 0 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,6 @@ target/
# IPython Notebook
.ipynb_checkpoints

# pyenv
.python-version

# celery beat schedule file
celerybeat-schedule

Expand Down
1 change: 1 addition & 0 deletions .python-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
3.11
17 changes: 13 additions & 4 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ git clone https://github.com/germainlefebvre4/libtado.git

## Requirements

The library development requires at least python `3.8`. Prefer developping with the version `3.10` minimum.
The library development requires at least python `3.8`. Prefer developping with the version `3.11` minimum.

This library is tested with following python versions:

Expand All @@ -24,10 +24,19 @@ Update your system and install a python version (at least the minimum required)

```bash
sudo apt update
sudo apt install python3.10 python3.10-pip
sudo apt install python3.11 python3.11-pip
sudo pip install poetry
```

Initialize your python virtual environment with the python version referenced in the `.python-version` file.

```bash
pyenv local
# output: 3.11
pyenv shell $(pyenv local)
poetry env use $(pyenv local)
```

Initialize your `poetry` setup and install all the development and test libraries.

```bash
Expand Down Expand Up @@ -79,10 +88,10 @@ poetry run mkdocs serve

Before validating your pull request, please run the following `tox` commands:

> *You can use your python version*: here `3.10`
> *You can use your python version*: here `3.11`
```bash
tox -e py3.10,lint,generate_json_schemas,unittest
tox -e py3.11,lint,generate_json_schemas,unittest
```

The pull request checking pipeline will run the same commands on several python versions to ensure the compatibility of the library.
Loading

0 comments on commit accb071

Please sign in to comment.