{"id":15442933,"url":"https://github.com/rmariano/compr","last_synced_at":"2025-04-19T20:14:54.582Z","repository":{"id":27015959,"uuid":"30480271","full_name":"rmariano/compr","owner":"rmariano","description":"A text compression tool \u0026 library","archived":false,"fork":false,"pushed_at":"2024-03-03T21:17:33.000Z","size":161,"stargazers_count":4,"open_issues_count":2,"forks_count":0,"subscribers_count":3,"default_branch":"develop","last_synced_at":"2024-10-18T13:16:57.136Z","etag":null,"topics":["algorithms","huffman","python","python-3","text-compression"],"latest_commit_sha":null,"homepage":"https://compr.readthedocs.io/en/latest/?badge=latest","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rmariano.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2015-02-08T04:06:49.000Z","updated_at":"2023-06-19T11:52:57.000Z","dependencies_parsed_at":"2024-03-03T22:27:21.392Z","dependency_job_id":"49ac46ef-9b19-421a-88ba-f71b2a143a14","html_url":"https://github.com/rmariano/compr","commit_stats":{"total_commits":192,"total_committers":2,"mean_commits":96.0,"dds":0.04166666666666663,"last_synced_commit":"c43f2d72b048248ca205aaf45241b31ea3ee6883"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rmariano%2Fcompr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rmariano%2Fcompr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rmariano%2Fcompr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rmariano%2Fcompr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rmariano","download_url":"https://codeload.github.com/rmariano/compr/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249789470,"owners_count":21325823,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["algorithms","huffman","python","python-3","text-compression"],"created_at":"2024-10-01T19:31:58.596Z","updated_at":"2025-04-19T20:14:54.549Z","avatar_url":"https://github.com/rmariano.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":".. image:: https://img.shields.io/travis/rmariano/compr.svg?style=flat-square\n   :target: https://travis-ci.org/rmariano/compr\n   :alt: CI Status\n\n.. image:: https://readthedocs.org/projects/compr/badge/?version=latest\u0026style=flat-square\n   :target: http://compr.readthedocs.io/en/latest/?badge=latest\n   :alt: Documentation Status\n\n.. image:: https://codecov.io/gh/rmariano/compr/branch/master/graph/badge.svg\n   :target: https://codecov.io/gh/rmariano/compr\n   :alt: coverage\n\n.. image:: https://img.shields.io/pypi/pyversions/trenzalore.svg?style=flat-square\n   :target: https://pypi.python.org/pypi/trenzalore\n\n\n.. begin\n\n.. contents ::\n\nPyCompress\n==========\n\n``Pycompressor`` is a tool for compressing text files into smaller ones, as\nwell as extracting compressed files back into the original content.\n\nIt can be used as a program or imported as a package module,\nand use the functions defined on it.\n\n\nFor example, in order to compress one file:\n\n.. code:: bash\n\n    $ pycompress -c /usr/share/dict/words -d /tmp/compressed.zf\n\nThe original file, in this example has a size of ``~4.8M``, and the tool left\nthe resulting file at ``/tmp/compressed.zf``, with a size of ``~2.7M``.\n\nIn order to extract it:\n\n.. code:: bash\n\n    $ pycompress -x /tmp/compressed.zf -d /tmp/original\n\nYou can specify the name of the resulting file with the ``-d`` flag. If you\ndon't indicate a name for the resulting file, the default will be\n``\u003coriginal-file\u003e.comp``.\n\nFor the full options, run:\n\n.. code:: bash\n\n    $ pycompress -h\n\n\nInstallation\n^^^^^^^^^^^^\n\n.. code:: bash\n\n   pip install trenzalore\n\n\nWill install the package and leave an application named ``pycompress`` for\nusing the command line utility.\n\n\nDevelopment\n^^^^^^^^^^^\n\nTo install the package in development mode, run::\n\n    make testdeps\n\nAnd run the tests with::\n\n    make test\n\nBefore submitting a pull request, run the checklist to make sure all\ndependencies are met (code style/linting, tests, pass, etc.). This is automated\nwith:\n\n.. code:: bash\n\n    make checklist\n\nThis will run the checks for the code style (``make lint``), as well as the\ntests (``make test``).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frmariano%2Fcompr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frmariano%2Fcompr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frmariano%2Fcompr/lists"}