Metadata¶

author¶

The name of the package author.

Example:

author: Dominic Davis-Foster

Required: yes

Type: String

classifiers¶

A list of “trove classifiers” for PyPI.

Example:

classifiers:
  - "Environment :: Console"

Classifiers are automatically added for the supported Python versions and implementations, and for most licenses.

Required: no

Default: [ ]

Type: Sequence of String

copyright_years¶

The copyright_years of the package.

Examples:

version: 2020

or

version: 2014-2019

Required: yes

Type: String or Integer

email¶

The email address of the author or maintainer.

Example:

email: dominic@example.com

Required: yes

Type: String

import_name¶

The name the package is imported with, if different to modname.

Example:

import_name: repo_helper

Required: no

Default: The value of modname

Type: String

keywords¶

A list of keywords for the project.

Example:

keywords:
  - version control
  - git
  - template

Required: no

Default: [ ]

Type: Sequence of String

license¶

The license for the project.

Example:

license: GPLv3+

Currently understands LGPLv3, LGPLv3, GPLv3, GPLv3, GPLv2 and BSD.

Required: yes

Type: String

modname¶

The name of the package.

Example:

modname: repo_helper

Required: yes

Type: String

on_pypi¶

Flag to indicate the package is available on PyPI.

Example:

on_pypi: True

Required: no

Default: True

Type: Boolean

pure_python¶

Flag to indicate the package is pure Python.

Example:

pure_python: True

Required: no

Default: True

Type: Boolean

pypi_name¶

The name of project on PyPI, if different to modname.

Example:

pypi_name: git-helper

Required: no

Default: The value of modname

Type: String

repo_name¶

The name of GitHub repository, if different to modname.

Example:

repo_name: repo_helper

Required: no

Default: The value of modname

Type: String

short_desc¶

A short description of the project. Used by PyPI.

Example:

short_desc: This is a short description of my project.

Required: yes

Type: String

source_dir¶

The directory containing the source code of the project.

Example:

source_dir: src

By default this is the repository root

Required: no

Default: <blank>

Type: String

stubs_package¶

Flag to indicate the package is a PEP 561 stubs package.

Example:

stubs_package: True

Required: no

Default: False

Type: Boolean

username¶

The username of the GitHub account hosting the repository.

Example:

username: domdfcoding

Required: yes

Type: String

version¶

The version of the package.

Example:

version: 0.0.1

Required: yes

Type: String or Float

assignee¶

The username of the GitHub account to assign issues to.

Defaults to username if unset.

Example:

username: repo-helper
assignee: domdfcoding

New in version 2020.11.23.

Required: no

Default: The value of username

Type: String