Skip to content

Latest commit

 

History

History
129 lines (94 loc) · 2.57 KB

Python - packaging.md

File metadata and controls

129 lines (94 loc) · 2.57 KB
Raw

Python packaging & project workflow

Packaging Python projects

Tutorial: https://packaging.python.org/tutorials/packaging-projects/

packaging_tutorial/
├── LICENSE
├── pyproject.toml
├── README.md
├── setup.cfg
├── setup.py  # optional, needed to make editable pip installs work
├── example_pkg/
│   └── __init__.py
└── tests/

📃 pyproject.toml

[build-system]
requires = [
    "setuptools>=42",
    "wheel"
]
build-backend = "setuptools.build_meta"

📃 setup.cfg

[metadata]
name = example-pkg
version = 0.0.1
author = Example Author
author_email = author@example.com
description = A small example package
long_description = file: README.md
long_description_content_type = text/markdown
url = https://github.com/pypa/sampleproject
project_urls =
    Bug Tracker = https://github.com/pypa/sampleproject/issues
classifiers =
    Programming Language :: Python :: 3
    License :: OSI Approved :: MIT License
    Operating System :: OS Independent

[options]
packages = find:
python_requires = >=3.6
install_requires =
    requests
    
[options.entry_points]
console_scripts =
    hello = example_pkg:main

[options.extras_require]
test =
    pytest

📃 setup.py

import setuptools

setuptools.setup()

📃 LICENSE

Usually I generate this file when creating new project on Github. You may also look here:

📃 example_pkg/init.py

The _VersionInfo stuff inspired by bandersnatch/init.py.

from typing import NamedTuple


class _VersionInfo (NamedTuple):
    major: int
    minor: int
    micro: int
    releaselevel: str
    serial: int

    @property
    def version_str(self) -> str:
        release_level = f".{self.releaselevel}" if self.releaselevel else ""
        return f"{self.major}.{self.minor}.{self.micro}{release_level}"


__version_info__ = _VersionInfo(
    major=4,
    minor=4,
    micro=0,
    releaselevel="",
    serial=0,
)
__version__ = __version_info__.version_str

Packaging binary extensions

https://packaging.python.org/guides/packaging-binary-extensions/

Example in my own project: https://github.com/messa/bloom/blob/main/setup.py

Links

https://github.com/mongodb/mongo-python-driver/blob/master/RELEASE.rst

https://stackoverflow.com/questions/458550/standard-way-to-embed-version-into-python-package