README.rst (1985B)
1 packaging 2 ========= 3 4 .. start-intro 5 6 Reusable core utilities for various Python Packaging 7 `interoperability specifications <https://packaging.python.org/specifications/>`_. 8 9 This library provides utilities that implement the interoperability 10 specifications which have clearly one correct behaviour (eg: :pep:`440`) 11 or benefit greatly from having a single shared implementation (eg: :pep:`425`). 12 13 .. end-intro 14 15 The ``packaging`` project includes the following: version handling, specifiers, 16 markers, requirements, tags, utilities. 17 18 Documentation 19 ------------- 20 21 The `documentation`_ provides information and the API for the following: 22 23 - Version Handling 24 - Specifiers 25 - Markers 26 - Requirements 27 - Tags 28 - Utilities 29 30 Installation 31 ------------ 32 33 Use ``pip`` to install these utilities:: 34 35 pip install packaging 36 37 Discussion 38 ---------- 39 40 If you run into bugs, you can file them in our `issue tracker`_. 41 42 You can also join ``#pypa`` on Freenode to ask questions or get involved. 43 44 45 .. _`documentation`: https://packaging.pypa.io/ 46 .. _`issue tracker`: https://github.com/pypa/packaging/issues 47 48 49 Code of Conduct 50 --------------- 51 52 Everyone interacting in the packaging project's codebases, issue trackers, chat 53 rooms, and mailing lists is expected to follow the `PSF Code of Conduct`_. 54 55 .. _PSF Code of Conduct: https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md 56 57 Contributing 58 ------------ 59 60 The ``CONTRIBUTING.rst`` file outlines how to contribute to this project as 61 well as how to report a potential security issue. The documentation for this 62 project also covers information about `project development`_ and `security`_. 63 64 .. _`project development`: https://packaging.pypa.io/en/latest/development/ 65 .. _`security`: https://packaging.pypa.io/en/latest/security/ 66 67 Project History 68 --------------- 69 70 Please review the ``CHANGELOG.rst`` file or the `Changelog documentation`_ for 71 recent changes and project history. 72 73 .. _`Changelog documentation`: https://packaging.pypa.io/en/latest/changelog/