dyens/deps-hell.png

## deps-hell.png

      
    Raw
  

              deps-hell.png
            
          
## linux.jpg

      
    Raw
  

              linux.jpg
            
          
## python_projects.org

      
    Raw
  

              python_projects.org
            
          
    General project

Semver

https://semver.org/lang/ru/
Учитывая номер версии МАЖОРНАЯ.МИНОРНАЯ.ПАТЧ, следует увеличивать:
МАЖОРНУЮ версию, когда сделаны обратно несовместимые изменения API.
  МИНОРНУЮ версию, когда вы добавляете новую функциональность, не нарушая обратной совместимости.
  ПАТЧ-версию, когда вы делаете обратно совместимые исправления.
Дополнительные обозначения для предрелизных и билд-метаданных возможны как дополнения к МАЖОРНАЯ.МИНОРНАЯ.ПАТЧ формату.
Changelog

https://keepachangelog.com/ru/0.3.0/
Типы проектов

Либа

Не строгие зависимости.
  Тесты на разных версиях\окружениях.
  Пушим в pypi
Сервис

Строгие зависмости
  Тесты под конкретное окружение
  Docker
Setup.py, setup.cfg

https://github.com/pypa/sampleproject/tree/db5806e0a3204034c51b1c00dde7d5eb3fa2532e
# setup.cfg
[metadata]
# This includes the license file(s) in the wheel.
# https://wheel.readthedocs.io/en/stable/user_guide.html#including-license-files-in-the-generated-wheel-file
license_files = LICENSE.txt
# setup.py
"""A setuptools based setup module.

See:
https://packaging.python.org/guides/distributing-packages-using-setuptools/
https://github.com/pypa/sampleproject
"""

# Always prefer setuptools over distutils
from setuptools import setup, find_packages
import pathlib

here = pathlib.Path(__file__).parent.resolve()
long_description = (here / "README.md").read_text(encoding="utf-8")
setup(
    # There are some restrictions on what makes a valid project name
    # specification here:
    # https://packaging.python.org/specifications/core-metadata/#name
    name="sampleproject",  # Required
    # Versions should comply with PEP 440:
    # https://www.python.org/dev/peps/pep-0440/
    #
    # For a discussion on single-sourcing the version across setup.py and the
    # project code, see
    # https://packaging.python.org/guides/single-sourcing-package-version/
    version="2.0.0",  # Required
    # This is a one-line description or tagline of what your project does. This
    # corresponds to the "Summary" metadata field:
    # https://packaging.python.org/specifications/core-metadata/#summary
    description="A sample Python project",  # Optional
    # This is an optional longer description of your project that represents
    # the body of text which users will see when they visit PyPI.
    #
    # Often, this is the same as your README, so you can just read it in from
    # that file directly (as we have already done above)
    #
    # This field corresponds to the "Description" metadata field:
    # https://packaging.python.org/specifications/core-metadata/#description-optional
    long_description=long_description,  # Optional
    # Denotes that our long_description is in Markdown; valid values are
    # text/plain, text/x-rst, and text/markdown
    #
    # Optional if long_description is written in reStructuredText (rst) but
    # required for plain-text or Markdown; if unspecified, "applications should
    # attempt to render [the long_description] as text/x-rst; charset=UTF-8 and
    # fall back to text/plain if it is not valid rst" (see link below)
    #
    # This field corresponds to the "Description-Content-Type" metadata field:
    # https://packaging.python.org/specifications/core-metadata/#description-content-type-optional
    long_description_content_type="text/markdown",  # Optional (see note above)
    # This should be a valid link to your project's main homepage.
    #
    # This field corresponds to the "Home-Page" metadata field:
    # https://packaging.python.org/specifications/core-metadata/#home-page-optional
    url="https://github.com/pypa/sampleproject",  # Optional
    # This should be your name or the name of the organization which owns the
    # project.
    author="A. Random Developer",  # Optional
    # This should be a valid email address corresponding to the author listed
    # above.
    author_email="author@example.com",  # Optional
    # Classifiers help users find your project by categorizing it.
    #
    # For a list of valid classifiers, see https://pypi.org/classifiers/
    classifiers=[  # Optional
        # How mature is this project? Common values are
        #   3 - Alpha
        #   4 - Beta
        #   5 - Production/Stable
        "Development Status :: 3 - Alpha",
        # Indicate who your project is intended for
        "Intended Audience :: Developers",
        "Topic :: Software Development :: Build Tools",
        # Pick your license as you wish
        "License :: OSI Approved :: MIT License",
        # Specify the Python versions you support here. In particular, ensure
        # that you indicate you support Python 3. These classifiers are *not*
        # checked by 'pip install'. See instead 'python_requires' below.
        "Programming Language :: Python :: 3",
        "Programming Language :: Python :: 3.7",
        "Programming Language :: Python :: 3.8",
        "Programming Language :: Python :: 3.9",
        "Programming Language :: Python :: 3.10",
        "Programming Language :: Python :: 3 :: Only",
    ],
    # This field adds keywords for your project which will appear on the
    # project page. What does your project relate to?
    #
    # Note that this is a list of additional keywords, separated
    # by commas, to be used to assist searching for the distribution in a
    # larger catalog.
    keywords="sample, setuptools, development",  # Optional
    # When your source code is in a subdirectory under the project root, e.g.
    # `src/`, it is necessary to specify the `package_dir` argument.
    package_dir={"": "src"},  # Optional
    # You can just specify package directories manually here if your project is
    # simple. Or you can use find_packages().
    #
    # Alternatively, if you just want to distribute a single Python file, use
    # the `py_modules` argument instead as follows, which will expect a file
    # called `my_module.py` to exist:
    #
    #   py_modules=["my_module"],
    #
    packages=find_packages(where="src"),  # Required
    # Specify which Python versions you support. In contrast to the
    # 'Programming Language' classifiers above, 'pip install' will check this
    # and refuse to install the project if the version does not match. See
    # https://packaging.python.org/guides/distributing-packages-using-setuptools/#python-requires
    python_requires=">=3.7, <4",
    # This field lists other packages that your project depends on to run.
    # Any package you put here will be installed by pip when your project is
    # installed, so they must be valid existing projects.
    #
    # For an analysis of "install_requires" vs pip's requirements files see:
    # https://packaging.python.org/discussions/install-requires-vs-requirements/
    install_requires=["peppercorn"],  # Optional
    # List additional groups of dependencies here (e.g. development
    # dependencies). Users will be able to install these using the "extras"
    # syntax, for example:
    #
    #   $ pip install sampleproject[dev]
    #
    # Similar to `install_requires` above, these must be valid existing
    # projects.
    extras_require={  # Optional
        "dev": ["check-manifest"],
        "test": ["coverage"],
    },
    # If there are data files included in your packages that need to be
    # installed, specify them here.
    package_data={  # Optional
        "sample": ["package_data.dat"],
    },
    # Entry points. The following would provide a command called `sample` which
    # executes the function `main` from this package when invoked:
    entry_points={  # Optional
        "console_scripts": [
            "sample=sample:main",
        ],
    },
    # List additional URLs that are relevant to your project as a dict.
    #
    # This field corresponds to the "Project-URL" metadata fields:
    # https://packaging.python.org/specifications/core-metadata/#project-url-multiple-use
    #
    # Examples listed include a pattern for specifying where the package tracks
    # issues, where the source is hosted, where to say thanks to the package
    # maintainers, and where to support the project financially. The key is
    # what's used to render the link text on PyPI.
    project_urls={  # Optional
        "Bug Reports": "https://github.com/pypa/sampleproject/issues",
        "Funding": "https://donate.pypi.org",
        "Say Thanks!": "http://saythanks.io/to/example",
        "Source": "https://github.com/pypa/sampleproject/",
    },
)
Setup.py removed in Python 3.12
pip install build
python -m build

  deprecated recommended
  python setup.py install python -m pip install .
  python setup.py develop python -m pip install –editable .
  python setup.py sdist python -m build
  python setup.py bdist wheel python -m build

Package formats

Sdist

Просто архив с исходником
Bdist

Собран под определенную архитектуру \ версию
Egg

Устанавливался раньше с помошью easy_install. В нем бинари + исходники
Wheel

Стандарт для python
  https://peps.python.org/pep-0491/
Pyproject.toml

https://github.com/pypa/sampleproject
[project]
# This is the name of your project. The first time you publish this
# package, this name will be registered for you. It will determine how
# users can install this project, e.g.:
#
# $ pip install sampleproject
#
# And where it will live on PyPI: https://pypi.org/project/sampleproject/
#
# There are some restrictions on what makes a valid project name
# specification here:
# https://packaging.python.org/specifications/core-metadata/#name
name = "sampleproject"  # Required

# Versions should comply with PEP 440:
# https://www.python.org/dev/peps/pep-0440/
#
# For a discussion on single-sourcing the version, see
# https://packaging.python.org/guides/single-sourcing-package-version/
version = "3.0.0"  # Required

# This is a one-line description or tagline of what your project does. This
# corresponds to the "Summary" metadata field:
# https://packaging.python.org/specifications/core-metadata/#summary
description = "A sample Python project"  # Optional

# This is an optional longer description of your project that represents
# the body of text which users will see when they visit PyPI.
#
# Often, this is the same as your README, so you can just read it in from
# that file directly (as we have already done above)
#
# This field corresponds to the "Description" metadata field:
# https://packaging.python.org/specifications/core-metadata/#description-optional
readme = "README.md" # Optional

# Specify which Python versions you support. In contrast to the
# 'Programming Language' classifiers above, 'pip install' will check this
# and refuse to install the project if the version does not match. See
# https://packaging.python.org/guides/distributing-packages-using-setuptools/#python-requires
requires-python = ">=3.7"

# This is either text indicating the license for the distribution, or a file
# that contains the license
# https://packaging.python.org/en/latest/specifications/core-metadata/#license
license = {file = "LICENSE.txt"}

# This field adds keywords for your project which will appear on the
# project page. What does your project relate to?
#
# Note that this is a list of additional keywords, separated
# by commas, to be used to assist searching for the distribution in a
# larger catalog.
keywords = ["sample", "setuptools", "development"]  # Optional

# This should be your name or the name of the organization who originally
# authored the project, and a valid email address corresponding to the name
# listed.
authors = [
  {name = "A. Random Developer", email = "author@example.com" } # Optional
]

# This should be your name or the names of the organization who currently
# maintains the project, and a valid email address corresponding to the name
# listed.
maintainers = [
  {name = "A. Great Maintainer", email = "maintainer@example.com" } # Optional
]

# Classifiers help users find your project by categorizing it.
#
# For a list of valid classifiers, see https://pypi.org/classifiers/
classifiers = [  # Optional
  # How mature is this project? Common values are
  #   3 - Alpha
  #   4 - Beta
  #   5 - Production/Stable
  "Development Status :: 3 - Alpha",

  # Indicate who your project is intended for
  "Intended Audience :: Developers",
  "Topic :: Software Development :: Build Tools",

  # Pick your license as you wish
  "License :: OSI Approved :: MIT License",

  # Specify the Python versions you support here. In particular, ensure
  # that you indicate you support Python 3. These classifiers are *not*
  # checked by "pip install". See instead "python_requires" below.
  "Programming Language :: Python :: 3",
  "Programming Language :: Python :: 3.7",
  "Programming Language :: Python :: 3.8",
  "Programming Language :: Python :: 3.9",
  "Programming Language :: Python :: 3.10",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3 :: Only",
]

# This field lists other packages that your project depends on to run.
# Any package you put here will be installed by pip when your project is
# installed, so they must be valid existing projects.
#
# For an analysis of this field vs pip's requirements files see:
# https://packaging.python.org/discussions/install-requires-vs-requirements/
dependencies = [ # Optional
  "peppercorn"
]

# List additional groups of dependencies here (e.g. development
# dependencies). Users will be able to install these using the "extras"
# syntax, for example:
#
#   $ pip install sampleproject[dev]
#
# Similar to `dependencies` above, these must be valid existing
# projects.
[project.optional-dependencies] # Optional
dev = ["check-manifest"]
test = ["coverage"]

# List URLs that are relevant to your project
#
# This field corresponds to the "Project-URL" and "Home-Page" metadata fields:
# https://packaging.python.org/specifications/core-metadata/#project-url-multiple-use
# https://packaging.python.org/specifications/core-metadata/#home-page-optional
#
# Examples listed include a pattern for specifying where the package tracks
# issues, where the source is hosted, where to say thanks to the package
# maintainers, and where to support the project financially. The key is
# what's used to render the link text on PyPI.
[project.urls]  # Optional
"Homepage" = "https://github.com/pypa/sampleproject"
"Bug Reports" = "https://github.com/pypa/sampleproject/issues"
"Funding" = "https://donate.pypi.org"
"Say Thanks!" = "http://saythanks.io/to/example"
"Source" = "https://github.com/pypa/sampleproject/"

# The following would provide a command line executable called `sample`
# which executes the function `main` from this package when invoked.
[project.scripts]  # Optional
sample = "sample:main"

# This is configuration specific to the `setuptools` build backend.
# If you are using a different build backend, you will need to change this.
[tool.setuptools]
# If there are data files included in your packages that need to be
# installed, specify them here.
package-data = {"sample" = ["*.dat"]}

[build-system]
# These are the assumed default build requirements from pip:
# https://pip.pypa.io/en/stable/reference/pip/#pep-517-and-518-support
requires = ["setuptools>=43.0.0", "wheel"]
build-backend = "setuptools.build_meta"
Build backends


  setuptools
  flit
  pdb
  hatchling

Easy_install

deprecated - используй pip
Pip

Устанавливает и билдит пакеты (use build).
  Может устанавливать с `pypi`, `git’, `local’
git+https://{token}@gitprovider.com/user/project.git@{version}
Можно добавлять приватные репы
PIP_INDEX_URL=https://my_private_repo pip install my-private-package

Virtualenv

python -m venv .venv
source .venv/bin/activate
Pyenv

https://github.com/pyenv/pyenv
pyenv install 3.10.4
pyenv local 3.7.13
ASDF

https://asdf-vm.com/
Mise

https://mise.jdx.dev/
mise ls-remote python
mise install python@3.10.10
mise local python@3.10.10
Сомнительные возможности ??? :

  переменные окружения (direnv)
  таски, watch

Sandbox

Поднимаем песочницу для экспериментов
mkdir /tmp/sandbox
cd /tmp/sandbox
mise local python@3.10.10 
python -m venv .venv
source .venv/bin/activate
pip install jupyterlab
jupyter lab

pip unistall jupyterlab # Оставит кучу зависимостей
Зависимости


      graph TD;
    Lib3-->Lib2;
    Lib3-->Lib1;
    Lib2-->MyProgramm;
    Lib1-->MyProgramm;

    
  Используйте virtualenv
  Устанавливайте все зависимости одним разом (requirements.txt)
  Lock зависимости

Pipenv

https://pipenv.pypa.io/en/latest/
  Кажется что редко кто использует теперь. Раньше была достаточно популярная
Poetry

https://python-poetry.org/
  Мощная, популярная система. Не знаешь что использовать- используй poetry
poetry new my-project
cd my_project
mise local python@3.12
poetry env use python3.12
# set version in pyproject ??

poetry add aiohttp
poetry add -G dev mypy
poetry lock
poetry install
poetry run python main.py
Проблемы:

  много зависимостей
  как именно паковать в докер
  дефолтный ^ для пакетов (мб хорошо для проектов, но для либ может быть плохо)

Hatch

https://hatch.pypa.io/latest/
hatch new "hatch example"
Не умеет lock. Но можно использовать pip-tools + есть либа hatch-pip-compile
  Делает разные environments - для тестов, для build docstring, …
  Как паковать в докер?
  Есть встроенный tox
Pure example


mise local python@3.12
python -m venv .venv
source .venv/bin/activate
pip install pip-tools
# pip install pyright
pip-tools

# генерирует requirements.txt, requirements-dev.txt
make pip-compile
# устанавливает зависимости из requirements.txt, requirements-dev.txt
make pip-sync
Tests


  unittest
  pytest

Mypy

Linters


  ruff
  pylint
  flake8

Для flake нужно устанавливать плагины:

  flake8-isort
  flake8-quotes
  flake8-commas
  flake8-bugbear
  https://wemake-python-styleguide.readthedocs.io/en/latest/

Formatters


  ruff
  black
  yapf
  isort

Configs

Главное, чтоб в коде вы использовали конфиг из одного места:
from config import settings
print(settings.database.username)
Хорошо бы иметь валидацию конфига.
- dotenv
  - dynaconf

  pydantic-settings

Twine

Загружает пакеты в pypi
  https://twine.readthedocs.io/en/stable/
pip install twine
python -m twine upload --repository testpypi dist/*
Tox

CICD

Пример моего коллеги для gitlab
Pre-commit

# install precommit from .pre-commit-config.yaml
pre-commit install
pre-commit  run --all-files
Usefull links


  Python packaging tutorial
  Semver
  Pyenv
  Mise
  Setuptools
  Wemakepython styleguide
  Twine
  Poetry
  Github python gitignore
  Python-dotenv
  Dynaconf
  Changlog
  Project example1
  Project example2
  Project example3
  Project example4 (Pure-example)
deprecated	recommended
python setup.py install	python -m pip install .
python setup.py develop	python -m pip install –editable .
python setup.py sdist	python -m build
python setup.py bdist wheel	python -m build