Packaging

additional_requirements_files

A list of files containing additional requirements.

These may define “extras” (see extras_require). Used in .readthedocs.yml.

Example:

additional_requirements_files:
  - submodule/requirements.txt

This list is automatically populated with any filenames specified in extras_require.

Any files specified here are listed in MANIFEST.in for inclusion in distributions.

Required: no

Default: [ ]

Type: Sequence of String

additional_setup_args

A dictionary of additional keyword arguments for setuptools.setup(). The values can refer to variables in __pkginfo__.py. String values must be enclosed in quotes here.

Example:

additional_setup_args:
  author: "'Dominic Davis-Foster'"
  entry_points: "None"

Required: no

Default: { }

Type: Mapping of String to String

console_scripts

A list of entries for console_scripts in setup.py. Each entry must follow the same format as required in setup.py.

Example:

console_scripts:
  - "repo_helper = repo_helper.__main__:main"
  - "git-helper = repo_helper.__main__:main"

Required: no

Default: [ ]

Type: Sequence of String

extras_require

A dictionary of extra requirements, where the keys are the names of the extras and the values are a list of requirements.

Example:

extras_require:
  extra_a:
    - pytz >=2019.1

or

extras_require:
  extra_a: pytz >=2019.1

or

extras_require:
  extra_a: < a filename >

Required: no

Default: { }

Type: Mapping of String to String

manifest_additional

A list of additional entries for MANIFEST.in.

Example:

manifest_additional:
  - "recursive-include: repo_helper/templates *"

Required: no

Default: [ ]

Type: Sequence of String

platforms

A case-insensitive list of platforms to perform tests for.

Example:

platforms:
  - Windows
  - macOS
  - Linux

These values determine the GitHub test workflows to enable, and the Trove classifiers used on PyPI.

Required: no

Default: [‘Windows’, ‘macOS’, ‘Linux’]

Type: Sequence of ‘Windows’ or ‘macOS’ or ‘Linux’

Allowed values: Windows, macOS, Linux

py_modules

A list of values for py_modules in setup.py, which indicate the single-file modules to include in the distributions.

Example:

py_modules:
  - domdf_spreadsheet_tools

Required: no

Default: [ ]

Type: Sequence of String

setup_pre

A list of additional python lines to insert at the beginnning of setup.py.

Example:

setup_pre:
  - import datetime
  - print(datetim.datetime.today())

Required: no

Default: [ ]

Type: Sequence of String

entry_points

A mapping of entry point categories to a list of entries for each category.

Each entry should be valid as per https://packaging.python.org/specifications/entry-points/

Example:

entry_points:
  pytest11:
    - "nbval = nbval.plugin"

Required: no

Default: { }

Type: Mapping of String to Sequence of String

use_whey

Whether to use whey to build distributions, rather than setuptools.build_meta.

New in version 2021.3.8.

Required: no

Default: False

Type: Boolean

use_flit

Whether to use flit to build distributions, rather than setuptools.build_meta.

New in version 2022.4.4.

Note

Support for flit is provisional and experimental.

Required: no

Default: False

Type: Boolean

use_maturin

Whether to use maturin to build distributions, rather than setuptools.build_meta.

New in version $VERSION.

Note

Support for maturin is provisional and experimental.

Required: no

Default: False

Type: Boolean

use_hatch

Whether to use hatch to build distributions, rather than setuptools.build_meta.

New in version $VERSION.

Note

Support for hatch is provisional and experimental.

Required: no

Default: False

Type: Boolean