METADATA 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899
  1. Metadata-Version: 2.1
  2. Name: lz4
  3. Version: 4.3.3
  4. Summary: LZ4 Bindings for Python
  5. Home-page: https://github.com/python-lz4/python-lz4
  6. Author: Jonathan Underwood
  7. Author-email: jonathan.underwood@gmail.com
  8. Classifier: Development Status :: 5 - Production/Stable
  9. Classifier: License :: OSI Approved :: BSD License
  10. Classifier: Intended Audience :: Developers
  11. Classifier: Programming Language :: C
  12. Classifier: Programming Language :: Python
  13. Classifier: Programming Language :: Python :: 3.8
  14. Classifier: Programming Language :: Python :: 3.9
  15. Classifier: Programming Language :: Python :: 3.10
  16. Classifier: Programming Language :: Python :: 3.11
  17. Classifier: Programming Language :: Python :: 3.12
  18. Requires-Python: >=3.8
  19. License-File: LICENSE
  20. Provides-Extra: docs
  21. Requires-Dist: sphinx >=1.6.0 ; extra == 'docs'
  22. Requires-Dist: sphinx-bootstrap-theme ; extra == 'docs'
  23. Provides-Extra: flake8
  24. Requires-Dist: flake8 ; extra == 'flake8'
  25. Provides-Extra: tests
  26. Requires-Dist: pytest !=3.3.0 ; extra == 'tests'
  27. Requires-Dist: psutil ; extra == 'tests'
  28. Requires-Dist: pytest-cov ; extra == 'tests'
  29. ==========
  30. python-lz4
  31. ==========
  32. Status
  33. ======
  34. .. image:: https://github.com/python-lz4/python-lz4/actions/workflows/build_dist.yml/badge.svg
  35. :target: https://github.com/python-lz4/python-lz4/actions/workflows/build_dist.yml
  36. :alt: Build Status
  37. .. image:: https://readthedocs.org/projects/python-lz4/badge/?version=stable
  38. :target: https://readthedocs.org/projects/python-lz4/
  39. :alt: Documentation
  40. .. image:: https://codecov.io/gh/python-lz4/python-lz4/branch/codecov/graph/badge.svg
  41. :target: https://codecov.io/gh/python-lz4/python-lz4
  42. :alt: CodeCov
  43. Introduction
  44. ============
  45. This package provides python bindings for the `LZ4 compression library
  46. <https://lz4.github.io/lz4/>`_.
  47. The production ready bindings provided in this package cover the `frame format
  48. <https://github.com/lz4/lz4/blob/master/doc/lz4_Frame_format.md>`_, and the
  49. `block format <https://github.com/lz4/lz4/blob/dev/doc/lz4_Block_format.md>`_
  50. specifications. The frame format bindings are the recommended ones to use, as
  51. this guarantees interoperability with other implementations and language
  52. bindings.
  53. Experimental bindings for the the `streaming format
  54. <https://github.com/lz4/lz4/blob/master/examples/streaming_api_basics.md>`_
  55. specification are also included, but further work on those is required.
  56. The API provided by the frame format bindings follows that of the LZMA, zlib,
  57. gzip and bzip2 compression libraries which are provided with the Python standard
  58. library. As such, these LZ4 bindings should provide a drop-in alternative to the
  59. compression libraries shipped with Python. The package provides context managers
  60. and file handler support.
  61. The bindings drop the GIL when calling in to the underlying LZ4 library, and is
  62. thread safe. An extensive test suite is included.
  63. Documentation
  64. =============
  65. .. image:: https://readthedocs.org/projects/python-lz4/badge/?version=stable
  66. :target: https://readthedocs.org/projects/python-lz4/
  67. :alt: Documentation
  68. Full documentation is included with the project. The documentation is
  69. generated using Sphinx. Documentation is also hosted on readthedocs.
  70. :master: http://python-lz4.readthedocs.io/en/stable/
  71. :development: http://python-lz4.readthedocs.io/en/latest/
  72. Homepage
  73. ========
  74. The `project homepage <https://www.github.com/python-lz4/python-lz4>`_ is hosted
  75. on Github. Please report any issues you find using the `issue tracker
  76. <https://github.com/python-lz4/python-lz4/issues>`_.
  77. Licensing
  78. =========
  79. Code specific to this project is covered by the `BSD 3-Clause License
  80. <http://opensource.org/licenses/BSD-3-Clause>`_