About
Summary: define the metadata of your project in a single place, then make it available at setup-time and at runtime.
Let’s consider the about package as an example ; we add to our project files, in the source tree, a file named about.py that contains the metadata of the project:
about |--- setup.py |--- README.md |... |--- about | |--- __init__.py | |... | |--- about.py
This file contains the metadata (and a little boilerplate):
# coding: utf-8 metadata = dict( __name__ = "about", __version__ = "5.1.1", __license__ = "MIT License", __author__ = u"Sébastien Boisgérault <Sebastien.Boisgerault@gmail.com>", __url__ = "https://warehouse.python.org/project/about", __summary__ = "Software Metadata for Humans", __keywords__ = "Python / 2.7, OS independent, software development" ) globals().update(metadata) __all__ = metadata.keys()
Setup. To use this metadata, the setup.py file includes the code:
import about
import about.about
info = about.get_metadata(about.about)
# add extra information (contents, requirements, etc.).
info.update(...)
if __name__ == "__main__":
setuptools.setup(**info)
Runtime. The metadata is stored as a collection of attributes of the about.about module. If we include in the about/__init__.py file the one-liner
from .about import *
they become available in the top-level module:
>>> import about >>> print about.__name__ about >>> print about.__version__ 5.1.1 >>> print about.__license__ MIT License
1 maintainer
Metadata
1 maintainer
Release files for about 5.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| about-5.2.tar.gz | 9.7 kB | Without provenance | Details |
Release files / about-5.2.tar.gz
| Download URL | about-5.2.tar.gz |
|---|---|
| Size | 9.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4a318ad1dcf6e9355b8ae18195c707d26413782b57ac5c740cc696b44350c959
|
|
BLAKE2b-256 checksum How to use checksums |
09ec81a547694206ae277feac573fda6e4726bb4440c07dbc81a01625fe4f0b1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for about 5.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
