File: README.rst

package info (click to toggle)
python-inflate64 1.0.1%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 1,360 kB
  • sloc: ansic: 3,429; python: 187; makefile: 4
file content (64 lines) | stat: -rw-r--r-- 1,899 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
inflate64
=========

.. image:: https://badge.fury.io/py/inflate64.svg
    :target: https://badge.fury.io/py/inflate64

.. image:: https://ci.codeberg.org/api/badges/12505/status.svg
    :target: https://ci.codeberg.org/repos/12505


The ``inflate64`` is a python package to provide ``Deflater`` and ``Inflater`` class to compress and
decompress with Enhanced Deflate compression algorithm.

The project is in ``Production/Stable`` status.

How to use
----------

You can install it with ``pip`` command as usual.

.. code-block::

  pip install inflate64


You can extract compressed data by instantiating ``Inflater`` class and call ``inflate`` method.

.. code-block:: python

  import inflate64
  decompressor = inflate64.Inflater()
  extracted = decompressor.inflate(data)


You can also compress data by instantiating ``Deflater`` class and call ``deflate`` method.

.. code-block:: python

  import inflate64
  compressor = inflate64.Deflater()
  compressed = compressor.deflate(data)
  compressed += compressor.flush()


License
-------

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

.. note::
   Please note that Enhanced Deflate algorithm is also known as `DEFLATE64` :sup:`TM`
   that is a registered trademark of `PKWARE, Inc.`