friendly_dist_manager.pyproject.project_table module¶

Primitives for manipulating the ‘project’ table in a pyproject.toml file

class friendly_dist_manager.pyproject.project_table.Entrypoint(name, ref)¶

Bases: tuple

Create new instance of Entrypoint(name, ref)

property name¶: Alias for field number 0

property ref¶: Alias for field number 1

class friendly_dist_manager.pyproject.project_table.Person(name, email)¶

Bases: tuple

Create new instance of Person(name, email)

property email¶: Alias for field number 1

property name¶: Alias for field number 0

class friendly_dist_manager.pyproject.project_table.ProjectTable(data)[source]¶

Bases: object

Abstraction around the ‘project’ table from a pyproject.toml file

References

https://www.python.org/dev/peps/pep-0621/

Parameters: data (dict) – TOML data parsed from a pyproject.toml config file

property authors¶

list of people who are considered ‘authors’ of the project

Note: each person may have a name and/or an email address, but either one may be omitted

Type: list(Person)

property classifiers¶

trove classifiers describing properties of the project

https://pypi.org/classifiers/

Type: list (str)

property console_scripts¶

list of entry points for console / shell scripts exposed by the project

Type: list (Entrypoint)

property dependencies¶

list of package dependencies associated with this project

References

https://www.python.org/dev/peps/pep-0508/

Type: list (str)

property description¶

descriptive name summarizing the purpose of the distribution

Type: str

property entrypoint_identifiers¶

list of custom entrypoint identifiers associated with the project

Type: list (str)

get_entrypoint(entrypoint_id)[source]¶

Gets definition for a custom entrypoint associated with the project

Parameters: entrypoint_id (str) – ID of the entrypoint to retrieve. See entrypoint_identifiers() for supported values
Returns: list of entrypoints associated with the entrypoint identifier
Return type: list (Entrypoint)

get_optional_dependencies(dependency_id)[source]¶

Set of dependencies associated with a specific group ID

References

https://www.python.org/dev/peps/pep-0508/

Parameters: dependency_id (str) – identifier for a specific group of optional dependencies associated with the project. See optional_dependency_identifiers() for list of valid options
Returns: list of dependency definitions for the optional dependencies associated with the specified ID
Return type: list (str)

property gui_scripts¶

list of application entry points for GUI based projects

Type: list (Entrypoint)

property keywords¶

descriptive keywords used when searching for project on pypi

Type: list (str)

property license¶

text explaining the licensing details associated with the project

Type: str

property maintainers¶

list of people who are considered ‘maintainers’ of the project

Note: each person may have a name and/or an email address, but either one may be omitted

Type: list(Person)

property name¶

name of the distribution being built

Type: str

property optional_dependency_identifiers¶

list of IDs associated with groups of optional package dependencies associated with the project

Type: list (str)

property python_requirement¶

the Python runtime version identifier indicating the range of versions supported by this project

Type: str

property readme¶

text formatted data loaded from the mentioned readme file associated with the project

Type: str

property readme_file¶

reference to the readme file associated with the project, or None if no readme file provided

Type: pathlib.Path

property urls¶

URLs providing additional information about the distribution package

Type: list (ProjectURL)

property version¶

version of the distribution being built

Type: str

class friendly_dist_manager.pyproject.project_table.ProjectURL(label, url)¶

Bases: tuple

Create new instance of ProjectURL(label, url)

property label¶: Alias for field number 0

property url¶: Alias for field number 1