lz4

LZ4 bindings for Python

Showing:

Popularity

Downloads/wk

0

GitHub Stars

176

Maintenance

Last Commit

8mos ago

Contributors

38

Package

Dependencies

6

License

Categories

Readme

==========

python-lz4

Status

.. image:: https://travis-ci.org/python-lz4/python-lz4.svg?branch=master :target: https://travis-ci.org/python-lz4/python-lz4 :alt: Build Status

.. image:: https://ci.appveyor.com/api/projects/status/r2qvw9mlfo63lklo/branch/master?svg=true :target: https://ci.appveyor.com/project/jonathanunderwood/python-lz4 :alt: Build Status Windows

.. image:: https://readthedocs.org/projects/python-lz4/badge/?version=stable :target: https://readthedocs.org/projects/python-lz4/ :alt: Documentation

.. image:: https://codecov.io/gh/python-lz4/python-lz4/branch/codecov/graph/badge.svg :target: https://codecov.io/gh/python-lz4/python-lz4 :alt: CodeCov

Introduction

This package provides python bindings for the LZ4 compression library <https://lz4.github.io/lz4/>_.

The bindings provided in this package cover the frame format <https://github.com/lz4/lz4/blob/master/doc/lz4_Frame_format.md>, the block format <https://github.com/lz4/lz4/blob/dev/doc/lz4_Block_format.md>, and the streaming format <https://github.com/lz4/lz4/blob/master/examples/streaming_api_basics.md>_ specifications. The frame format bindings are the recommended ones to use, as this guarantees interoperability with other implementations and language bindings.

The API provided by the frame format bindings follows that of the LZMA, zlib, gzip and bzip2 compression libraries which are provided with the Python standard library. As such, these LZ4 bindings should provide a drop-in alternative to the compression libraries shipped with Python. The package provides context managers and file handler support.

The bindings drop the GIL when calling in to the underlying LZ4 library, and is thread safe. An extensive test suite is included.

Documentation

.. image:: https://readthedocs.org/projects/python-lz4/badge/?version=stable :target: https://readthedocs.org/projects/python-lz4/ :alt: Documentation

Full documentation is included with the project. The documentation is generated using Sphinx. Documentation is also hosted on readthedocs.

:master: http://python-lz4.readthedocs.io/en/stable/ :development: http://python-lz4.readthedocs.io/en/latest/

Homepage

The project homepage <https://www.github.com/python-lz4/python-lz4> is hosted on Github. Please report any issues you find using the issue tracker <https://github.com/python-lz4/python-lz4/issues>.

Licensing

Code specific to this project is covered by the BSD 3-Clause License <http://opensource.org/licenses/BSD-3-Clause>_

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100