README.rst 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637
  1. ================
  2. python-zstandard
  3. ================
  4. | |ci-test| |ci-wheel| |ci-typing| |ci-sdist| |ci-anaconda| |ci-sphinx|
  5. This project provides Python bindings for interfacing with the
  6. `Zstandard <http://www.zstd.net>`_ compression library. A C extension
  7. and CFFI interface are provided.
  8. The primary goal of the project is to provide a rich interface to the
  9. underlying C API through a Pythonic interface while not sacrificing
  10. performance. This means exposing most of the features and flexibility
  11. of the C API while not sacrificing usability or safety that Python provides.
  12. The canonical home for this project is
  13. https://github.com/indygreg/python-zstandard.
  14. For usage documentation, see https://python-zstandard.readthedocs.org/.
  15. .. |ci-test| image:: https://github.com/indygreg/python-zstandard/workflows/.github/workflows/test.yml/badge.svg
  16. :target: https://github.com/indygreg/python-zstandard/blob/main/.github/workflows/test.yml
  17. .. |ci-wheel| image:: https://github.com/indygreg/python-zstandard/workflows/.github/workflows/wheel.yml/badge.svg
  18. :target: https://github.com/indygreg/python-zstandard/blob/main/.github/workflows/wheel.yml
  19. .. |ci-typing| image:: https://github.com/indygreg/python-zstandard/workflows/.github/workflows/typing.yml/badge.svg
  20. :target: https://github.com/indygreg/python-zstandard/blob/main/.github/workflows/typing.yml
  21. .. |ci-sdist| image:: https://github.com/indygreg/python-zstandard/workflows/.github/workflows/sdist.yml/badge.svg
  22. :target: https://github.com/indygreg/python-zstandard/blob/main/.github/workflows/sdist.yml
  23. .. |ci-anaconda| image:: https://github.com/indygreg/python-zstandard/workflows/.github/workflows/anaconda.yml/badge.svg
  24. :target: https://github.com/indygreg/python-zstandard/blob/main/.github/workflows/anaconda.yml
  25. .. |ci-sphinx| image:: https://github.com/indygreg/python-zstandard/workflows/.github/workflows/sphinx.yml/badge.svg
  26. :target: https://github.com/indygreg/python-zstandard/blob/main/.github/workflows/sphinx.yml