packaging

Although one can use tox to develop and test applications one of its most popular usage is to help library creators. Libraries need first to be packaged, so then they can be installed inside a virtual environment for testing. To help with this tox implements PEP-517 and PEP-518. This means that by default tox will build source distribution out of source trees. Before running test commands pip is used to install the source distribution inside the build environment.

To create a source distribution there are multiple tools out there and with PEP-517 and PEP-518 you can easily use your favorite one with tox. Historically tox only supported setuptools, and always used the tox host environment to build a source distribution from the source tree. This is still the default behavior. To opt out of this behaviour you need to set isolated builds to true.

setuptools

Using the pyproject.toml file at the root folder (alongside setup.py) one can specify build requirements.

[build-system]
requires = [
    "setuptools >= 35.0.2",
    "setuptools_scm >= 2.0.0, <3"
]
build-backend = "setuptools.build_meta"
# tox.ini
[tox]
isolated_build = True

flit

flit requires Python 3, however the generated source distribution can be installed under python 2. Furthermore it does not require a setup.py file as that information is also added to the pyproject.toml file.

[build-system]
requires = ["flit >= 1.1"]
build-backend = "flit.buildapi"

[tool.flit.metadata]
module = "package_toml_flit"
author = "Happy Harry"
author-email = "[email protected]"
home-page = "https://github.com/happy-harry/is"
# tox.ini
[tox]
isolated_build = True

[tox:.package]
# note tox will use the same python version as under what tox is installed to package
# so unless this is python 3 you can require a given python version for the packaging
# environment via the basepython key
basepython = python3

poetry

poetry requires Python 3, however the generated source distribution can be installed under python 2. Furthermore it does not require a setup.py file as that information is also added to the pyproject.toml file.

[build-system]
requires = ["poetry >= 0.12, <1"]
build-backend = "poetry.masonry.api"

[tool.poetry]
name = "package_toml_poetry"
version = "0.1.0"
description = ""
authors = ["Name <[email protected]>"]
# tox.ini
[tox]
isolated_build = True

[tox:.package]
# note tox will use the same python version as under what tox is installed to package
# so unless this is python 3 you can require a given python version for the packaging
# environment via the basepython key
basepython = python3