https://github.com/rmariano/compr
A text compression tool & library
https://github.com/rmariano/compr
algorithms huffman python python-3 text-compression
Last synced: 9 months ago
JSON representation
A text compression tool & library
- Host: GitHub
- URL: https://github.com/rmariano/compr
- Owner: rmariano
- License: mit
- Created: 2015-02-08T04:06:49.000Z (almost 11 years ago)
- Default Branch: develop
- Last Pushed: 2024-03-03T21:17:33.000Z (almost 2 years ago)
- Last Synced: 2024-10-18T13:16:57.136Z (about 1 year ago)
- Topics: algorithms, huffman, python, python-3, text-compression
- Language: Python
- Homepage: https://compr.readthedocs.io/en/latest/?badge=latest
- Size: 157 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
.. image:: https://img.shields.io/travis/rmariano/compr.svg?style=flat-square
:target: https://travis-ci.org/rmariano/compr
:alt: CI Status
.. image:: https://readthedocs.org/projects/compr/badge/?version=latest&style=flat-square
:target: http://compr.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://codecov.io/gh/rmariano/compr/branch/master/graph/badge.svg
:target: https://codecov.io/gh/rmariano/compr
:alt: coverage
.. image:: https://img.shields.io/pypi/pyversions/trenzalore.svg?style=flat-square
:target: https://pypi.python.org/pypi/trenzalore
.. begin
.. contents ::
PyCompress
==========
``Pycompressor`` is a tool for compressing text files into smaller ones, as
well as extracting compressed files back into the original content.
It can be used as a program or imported as a package module,
and use the functions defined on it.
For example, in order to compress one file:
.. code:: bash
$ pycompress -c /usr/share/dict/words -d /tmp/compressed.zf
The original file, in this example has a size of ``~4.8M``, and the tool left
the resulting file at ``/tmp/compressed.zf``, with a size of ``~2.7M``.
In order to extract it:
.. code:: bash
$ pycompress -x /tmp/compressed.zf -d /tmp/original
You can specify the name of the resulting file with the ``-d`` flag. If you
don't indicate a name for the resulting file, the default will be
``.comp``.
For the full options, run:
.. code:: bash
$ pycompress -h
Installation
^^^^^^^^^^^^
.. code:: bash
pip install trenzalore
Will install the package and leave an application named ``pycompress`` for
using the command line utility.
Development
^^^^^^^^^^^
To install the package in development mode, run::
make testdeps
And run the tests with::
make test
Before submitting a pull request, run the checklist to make sure all
dependencies are met (code style/linting, tests, pass, etc.). This is automated
with:
.. code:: bash
make checklist
This will run the checks for the code style (``make lint``), as well as the
tests (``make test``).