neogeogre / python-best-setup

Optimal python project setup

python-best-setup

This setup is the best and lightest one to ensure a consistent robustness of a python project in terms of python version and libraries versions. With this you can also easily switch between python versions among several projects without the risk to have side effect or clashes. Also this will keep the python of your OS untouched reduccing the risk of damaging your OS.

pyenv

install required libraries: https://github.com/pyenv/pyenv/wiki#:~:text=zlib%20tcl%2Dtk-,Ubuntu/Debian/Mint%3A,-sudo%20apt%20update

install pyenv : https://github.com/pyenv/pyenv-installer#install

you may need also :

sudo apt install python-is-python3

then setup python version like the one in the .python-version file.

pyenv install 3.9.15
pyenv global 3.9.15

check that the installed version is correct with:

pyenv versions

and:

python -V

poetry

install poetry: https://github.com/python-poetry/poetry#installation

up to now you have to execute commands in the project folder like:

cd ~/python-best-setup

then do:

pyenv local 3.9.15

then do:

poetry config virtualenvs.in-project true

Now install dependencies with:

poetry install

if everything has been setup properly

poetry run python -V

should return the version written in the toml file and the .python-version.

You can also update the dependencies with:

poetry update

Finaly execute your code with:

poetry run python main.py

please check: https://python-poetry.org/docs/basic-usage/