📦 py-tiny-pkg

• a tiny packaging example that only has a pyproject.toml w/setuptools 🔨
• 🎉 setuptools v61.0.0 is released with experimental support for pyproject.toml
  • 📄 official documentation https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html
  • 💬 discussions https://discuss.python.org/t/help-testing-experimental-features-in-setuptools/

🦾 motivation

• we can find lots of packaging examples with poetry, pdm, etc., but hard to find examples with the standard setuptools based on the latest PEP supports.

✔️ confirmed versions

• Ubuntu 20.04 Mac OS X 11.6.4
• python 3.7.*, 3.8.*, 3.9.*
• pip 22.0.4+

⬇️ install locally

• clone this repo
• $ pip install . or $ pip install .[dev] (for testing)
• $ pip show -f tinypkg

Name: tinypkg
Version: 0.0.5.dev0+g1b7cb5d.d20220925
Summary: a tiny package example w/setuptools
Home-page: github.com/denkiwakame/py-tiny-pkg
Author: denkiwakame
Author-email:
License: MIT License
        Copyright (c) 2022 denkiwakame
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Location: /home/mai/Garage/py-tiny-pkg/.venv/lib/python3.10/site-packages
Requires: requests
Required-by:
Files:
  tinypkg-0.0.5.dev0+g1b7cb5d.d20220925.dist-info/INSTALLER
  tinypkg-0.0.5.dev0+g1b7cb5d.d20220925.dist-info/LICENSE.txt
  tinypkg-0.0.5.dev0+g1b7cb5d.d20220925.dist-info/METADATA
  tinypkg-0.0.5.dev0+g1b7cb5d.d20220925.dist-info/RECORD
  tinypkg-0.0.5.dev0+g1b7cb5d.d20220925.dist-info/REQUESTED
  tinypkg-0.0.5.dev0+g1b7cb5d.d20220925.dist-info/WHEEL
  tinypkg-0.0.5.dev0+g1b7cb5d.d20220925.dist-info/direct_url.json
  tinypkg-0.0.5.dev0+g1b7cb5d.d20220925.dist-info/top_level.txt
  tinypkg/__init__.py
  tinypkg/__pycache__/__init__.cpython-310.pyc
  tinypkg/__pycache__/_version.cpython-310.pyc
  tinypkg/__pycache__/hi.cpython-310.pyc
  tinypkg/_version.py
  tinypkg/hi.py

👩‍🔧 testing

• $ pip install .[dev]
• $ python -m pytest --cov

install from GitHub.com

• pip install git+https://github.com/denkiwakame/py-tiny-pkg

📝 editable install (-e)

• 🎉 setuptools v64.0.0+ supports editable installation!
  • https://setuptools.pypa.io/en/latest/userguide/development_mode.html
  • 📑 PEP660 https://peps.python.org/pep-0660/
  • pypa/setuptools#3488
  • pip 21.1+ supports build_editable hook https://pip.pypa.io/en/stable/reference/build-system/pyproject-toml/#editable-installation

❓ src-layout vs. flat-layout

• see https://setuptools.pypa.io/en/stable/userguide/package_discovery.html

❓ How can I manage ext_modules ?

• pyproject.toml does not strictly intend to replace setup.py .
• If you need to build C/C++ extension modules w/pybind11 or something, write the following setup.py (dynamic config) alongside with the pyproject.toml (metadata file).

import subprocess
import os
import sys

from setuptools import Extension, setup
from setuptools.command.build_ext import build_ext

class CMakeExtension(Extension):
    def __init__(self, name, sourcedir=""):
        Extension.__init__(self, name, sources=[])
        self.sourcedir = os.path.abspath(sourcedir)

class CMakeBuild(build_ext):
    def build_extension(self, ext):
        cfg = "Debug" if self.debug else "Release"  # TODO
        extdir = os.path.abspath(os.path.dirname(
            self.get_ext_fullpath(ext.name)))
        cmake_args = [
            f"-DCMAKE_LIBRARY_OUTPUT_DIRECTORY={extdir}",
            f"-DPYTHON_EXECUTABLE={sys.executable}",
            f"-DCMAKE_BUILD_TYPE={cfg}",
        ]
        build_args = []
        if not os.path.exists(self.build_temp):
            os.makedirs(self.build_temp)
        subprocess.check_call(
            ["cmake", ext.sourcedir] + cmake_args, cwd=self.build_temp
        )
        subprocess.check_call(
            ["cmake", "--build", "."] + build_args, cwd=self.build_temp
        )
setup(
    ext_modules=[CMakeExtension("bindings")],
    cmdclass={"build_ext": CMakeBuild},
)

📦 publish to PyPI

• use pypa/build, a simple PEP 517 frontend and pypa/gh-action-pypi-publish
  • https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/

📚 Refernces

pyproject.toml

• https://pip.pypa.io/en/stable/reference/build-system/pyproject-toml/

build-system

• 📑 PEP 517 https://www.python.org/dev/peps/pep-0517/
  • setuptools support https://setuptools.pypa.io/en/latest/build_meta.html
• 📑 PEP 518 https://www.python.org/dev/peps/pep-0518/

(FYI) Commonly Used build-backend Options

Backend	Specification	Features	Recommended Use Cases
setuptools	setuptools.build_meta	Stable and widely used. Often the default choice for many projects.	Legacy projects or when minimal dependency management is needed.
hatchling	hatchling.build	Lightweight and fast. Modern design with simple dependency management.	New projects where simplicity and speed are prioritized.
poetry-core	poetry.core.masonry.api	Simplified version of poetry. Excellent for strict dependency management.	Projects requiring robust dependency management.
flit	flit_core.buildapi	Designed for simple package structures. Very lightweight and easy to use.	Ideal for small libraries or script distribution.
pdm-backend	pdm.backend	Modern and fully compatible with pyproject.toml. Advanced dependency resolution.	Flexible for a wide range of project types.

metadata

• 📑 PEP 621 https://peps.python.org/pep-0621/
  • setuptools support (wip) pypa/setuptools#1688
  • experimental release https://discuss.python.org/t/help-testing-experimental-features-in-setuptools/13821

linter support for pyproject.toml

• black (supported)
• isort (supported)
• mypy (supported) python/mypy#5205
• flake8 PyCQA/flake8#234
  • pyproject-flake8 https://github.com/csachs/pyproject-flake8