| packaging |
| ========= |
|
|
| .. start-intro |
|
|
| Reusable core utilities for various Python Packaging |
| `interoperability specifications <https://packaging.python.org/specifications/>`_. |
|
|
| This library provides utilities that implement the interoperability |
| specifications which have clearly one correct behaviour (eg: :pep:`440`) |
| or benefit greatly from having a single shared implementation (eg: :pep:`425`). |
|
|
| .. end-intro |
|
|
| The ``packaging`` project includes the following: version handling, specifiers, |
| markers, requirements, tags, metadata, lockfiles, utilities. |
|
|
| Documentation |
| ------------- |
|
|
| The `documentation`_ provides information and the API for the following: |
|
|
| - Version Handling |
| - Specifiers |
| - Markers |
| - Licenses |
| - Requirements |
| - Metadata |
| - Tags |
| - Lockfiles (pylock) |
| - Direct URL helpers |
| - Dependency groups |
| - Errors |
| - Utilities |
|
|
| Installation |
| ------------ |
|
|
| Use ``pip`` to install these utilities:: |
| |
| pip install packaging |
|
|
| The ``packaging`` library uses calendar-based versioning (``YY.N``). |
|
|
| Discussion |
| ---------- |
|
|
| If you run into bugs, you can file them in our `issue tracker`_. |
|
|
| You can also join discussions on `GitHub Discussions`_ to ask questions or get involved. |
|
|
| .. _`documentation`: https://packaging.pypa.io/ |
| .. _`issue tracker`: https://github.com/pypa/packaging/issues |
| .. _`GitHub Discussions`: https://github.com/pypa/packaging/discussions |
|
|
|
|
| Code of Conduct |
| --------------- |
|
|
| Everyone interacting in the packaging project's codebases, issue trackers, chat |
| rooms, and mailing lists is expected to follow the `PSF Code of Conduct`_. |
|
|
| .. _PSF Code of Conduct: https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md |
|
|
| Contributing |
| ------------ |
|
|
| The ``CONTRIBUTING.rst`` file outlines how to contribute to this project as |
| well as how to report a potential security issue. The documentation for this |
| project also covers information about `project development`_ and `security`_. |
|
|
| .. _`project development`: https://packaging.pypa.io/en/latest/development/ |
| .. _`security`: https://packaging.pypa.io/en/latest/security/ |
|
|
| Project History |
| --------------- |
|
|
| Please review the ``CHANGELOG.rst`` file or the `Changelog documentation`_ for |
| recent changes and project history. |
|
|
| .. _`Changelog documentation`: https://packaging.pypa.io/en/latest/changelog/ |
|
|
