README.rst 2.0 KB

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