PackageContext
Information about a package.
author_email
class-attribute
instance-attribute
¶
A description for the distribution [Metadata]
author_name
class-attribute
instance-attribute
¶
The author name of the distribution [Metadata]
authors
class-attribute
instance-attribute
¶
All authors of the distribution [Metadata]
build_system
class-attribute
instance-attribute
¶
build_system: buildsystems.BuildSystem = dataclasses.field(
default_factory=lambda: buildsystems.hatch
)
The build system set as build backend [pyproject]
classifier_map
class-attribute
instance-attribute
¶
Distribution classifiers, sorted by category [Metadata]
classifiers
class-attribute
instance-attribute
¶
Distribution classifiers [Metadata]
cli
class-attribute
instance-attribute
¶
The cli package name used by the distribution.
cli_info
class-attribute
instance-attribute
¶
An object containing information about all cli commands.
commit_types
class-attribute
instance-attribute
¶
Commit types defined in pyproject mknodes section [pyproject]
configured_build_systems
class-attribute
instance-attribute
¶
A list of build systems which are configured in pyproject [pyproject]
description
class-attribute
instance-attribute
¶
A description for the distribution [Metadata]
distribution_name
class-attribute
instance-attribute
¶
The name of the distribution [Metadata]
docstring_style
class-attribute
instance-attribute
¶
The style used for DocStrings.
entry_points
class-attribute
instance-attribute
¶
A dictionary containing the entry points of the distribution.
extras
class-attribute
instance-attribute
¶
The extras of the distribution.
griffe_module
class-attribute
instance-attribute
¶
The module object itself.
homepage
class-attribute
instance-attribute
¶
The main website of the distribution.
inventory_url
class-attribute
instance-attribute
¶
A best guess for an inventory URL for the package.
keywords
class-attribute
instance-attribute
¶
Distribution keywords [Metadata]
license_text
class-attribute
instance-attribute
¶
The complete license text
line_length
class-attribute
instance-attribute
¶
The line length, if defined by any popular tool [pyproject]
mkdocs_config
class-attribute
instance-attribute
¶
A dict-like File containing the MkDocs config.
module
class-attribute
instance-attribute
¶
The module object itself.
package_repos
class-attribute
instance-attribute
¶
Package repositories the distribution is distributed on. Defined in pyproject mknodes section [pyproject]
pretty_name
class-attribute
instance-attribute
¶
A pretty name for the distribution (like MkNodes) [MkDocs site name]
pyproject_file
class-attribute
instance-attribute
¶
A dict-like File containing the PyProject data.
repository_name
class-attribute
instance-attribute
¶
The repository name of the distribution.
repository_path
class-attribute
instance-attribute
¶
The path to the local git repository.
repository_url
class-attribute
instance-attribute
¶
The URL to the remote code repository.
repository_username
class-attribute
instance-attribute
¶
The username for the remote code repository.
required_package_names
class-attribute
instance-attribute
¶
The names of the dependencies.
required_packages
class-attribute
instance-attribute
¶
PackageInfos for the dependencies.
required_python_version
class-attribute
instance-attribute
¶
The required python version for the distribution [Metadata]
social_info
class-attribute
instance-attribute
¶
A icon-name -> URL dictionary containing .
summary
class-attribute
instance-attribute
¶
A summary for the distribution [Metadata]
task_runners
class-attribute
instance-attribute
¶
Task runners used by the distribution.
tool_section
class-attribute
instance-attribute
¶
The tool section of the pyproject file.
Comes as a SuperDict. (A Mutable mapping with extended capabilities) [pyproject]
tools
class-attribute
instance-attribute
¶
A list of tools found for the distribution.
urls
class-attribute
instance-attribute
¶
A set of URLs related to the distribution.
version
class-attribute
instance-attribute
¶
The version of the distribution [Metadata]
Page info
Resources
Resources(css=[],
markdown_extensions={'attr_list': {},
'md_in_html': {},
'pymdownx.emoji': {'emoji_generator': <function to_svg at 0x7fd32a7ad800>,
'emoji_index': <function twemoji at 0x7fd32a7ad6c0>},
'pymdownx.magiclink': {'repo': 'mknodes',
'repo_url_shorthand': True,
'user': 'phil65'}},
plugins=[Plugin('mkdocstrings')],
js=[],
assets=[],
packages=[])