Python Project Practice

PPP.md

This practice is for Unix

Python Environment Preparation

Tools Installation

1. Use Homebrew to install Pipx
2. Use Pipx to install Poetry and Tox
3. Use Homebrew (or official installer) to install Pyenv and Pyenv-virtualenv

Python Installation

1. Use Pyenv install Python versions
2. Run pyenv global 3.a 3.b 3.c to set global Python versions(plural)¹

Project Development

With Poetry

1. Run poetry new PROJECT_NAME to create a new Poetry project
2. Run pyenv local 3.a 3.b 3.c to set multiple local Python versions
3. Run poetry env use 3.a to create a Poetry virtual environment
4. [Optional] Run poetry install to install current package into virtual environment
5. Develop

With Pyenv-virtualenv

1. Run pyenv virtualenv 3.a PROJECT_NAME to create a new virtual environment
2. Run pyenv local PROJECT_NAME 3.a 3.b 3.c to set multiple local Python versions
3. [Optional] Run pip install --editable . to install current package into virtual environment
4. Develop

src Layout

Why can setuptools detect src layout?

• https://setuptools.pypa.io/en/latest/userguide/package_discovery.html#automatic-discovery

Reference

• https://docs.pytest.org/en/7.1.x/explanation/goodpractices.html#src-layout
• https://blog.ionelmc.ro/2014/05/25/python-packaging/#the-structure%3E
• https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/

Footnotes

1. https://github.com/pyenv/pyenv/blob/master/COMMANDS.md#pyenv-global ↩