Installation

pip install setuptools-build-subpackage

You can also install the in-development version with:

pip install https://github.com/ashb/setuptools-build-subpackage/archive/master.zip

Usage

This distribution contains a subclass of setuptools’s Distribution, designed to build a “sub-module” as a stand alone distribution.

It is designed to be used with setuptools’s declrative config – i.e. where everything is defined in setup.cfg, not in setup.py

For example, take the following layout:

├── example
│   ├── __init__.py
│   ├── sub_module_a
│   │   ├── __init__.py
│   │   ├── setup.cfg
│   │   └── where.py
│   └── sub_module_b
│       ├── __init__.py
│       ├── setup.cfg
│       └── where.py
└── setup.cfg

This assumes we want example.sub_module_a and example.sub_module_b not included in the main distribution, but instead released as separate dists to PyPI.

This set of classes ensures the following:

• That the top level setup.cfg is not loaded, instead only the one specified from the sub-package

• That the build/ folder for each sub-package is kept clean, so files from one build don’t leak in to another

• That the setup.cfg from the sub-folder is present in the built sdist at the top level, meaning it can be installed normally.

• That a stub setup.py file is included for compatibility with older installers

setup(
    ...
    packages=find_packages(exclude=['example.sub_module_*'])
)

[options.packages.find]
exclude =
  example.sub_module_*

python -m setuptools_build_subpackage \
  --subpackage-folder example/sub_module_b \
  sdist \
  bdist_wheel

python -m setuptools_build_subpackage \
  --subpackage-folder example/sub_module_b \
  sdist --license-template ./LICENSE \
  bdist_wheel

Development

To run all the tests run:

pip install -e '.[devel]' && pytest

It is also recommended that you install pre-commit to check style rules

Changelog