More writing examples and improving documentation.
[pyutils.git] / docs / pyutils.compress.rst
1 pyutils.compress package
2 ========================
3
4 Submodules
5 ----------
6
7 pyutils.compress.letter\_compress module
8 ----------------------------------------
9
10 This is a simple, honestly, toy compression scheme that uses a custom
11 alphabet of 32 characters which can each be represented in six bits
12 instead of eight.  It therefore reduces the size of data composed of
13 only those letters by 25% without loss.
14
15 .. automodule:: pyutils.compress.letter_compress
16    :members:
17    :undoc-members:
18    :show-inheritance:
19
20 Module contents
21 ---------------
22
23 .. automodule:: pyutils.compress
24    :members:
25    :undoc-members:
26    :show-inheritance: