description | Rar archive reader for Python |
homepage URL | https://github.com/markokr/rarfile |
repository URL | https://github.com/markokr/rarfile.git |
owner | vadmium+repo@gmail.com |
last change | Sun, 7 Apr 2024 20:07:33 +0000 (7 23:07 +0300) |
last refresh | Sun, 22 Sep 2024 06:19:59 +0000 (22 08:19 +0200) |
mirror URL | git://repo.or.cz/rarfile.git |
| https://repo.or.cz/rarfile.git |
| ssh://git@repo.or.cz/rarfile.git |
bundle info | rarfile.git downloadable bundles |
content tags
|
|
README.rst
rarfile - RAR archive reader for Python
=======================================
This is Python module for RAR_ archive reading.
The interface follows the style of zipfile_.
Licensed under ISC_ license.
Features:
* Supports both RAR3 and RAR5 format archives.
* Supports multi volume archives.
* Supports Unicode filenames.
* Supports password-protected archives.
* Supports archive and file comments.
* Archive parsing and non-compressed files are handled in pure Python code.
* Compressed files are extracted by executing external tool:
unrar_ (preferred), unar_, 7zip_ or bsdtar_.
* Works with Python 3.6+.
.. _RAR: https://en.wikipedia.org/wiki/RAR_%28file_format%29
.. _zipfile: https://docs.python.org/3/library/zipfile.html
.. _ISC: https://en.wikipedia.org/wiki/ISC_license
.. _bsdtar: https://github.com/libarchive/libarchive
.. _unrar: https://www.rarlab.com/
.. _unar: https://theunarchiver.com/command-line
.. _7zip: https://www.7-zip.org/
Backends:
+-------------+----------------------+-----------------------------------------------------+
| Backend | Status | Notes |
+=============+======================+=====================================================+
| unrar_ | Supported | * Recommended: full format support. |
| | | * Non-free software, but free to use. |
+-------------+----------------------+-----------------------------------------------------+
| unar_ | Supported | * Not usable on Windows: last build is from 2013 |
| | | (v1.8.1) that does support output to stdout. |
| | | * Does not support RAR2 locked files. |
| | | * Does not support RAR5 Blake2 hash checking. |
+-------------+----------------------+-----------------------------------------------------+
| 7zip_ | Supported | * RAR support not available on Debian/Ubuntu repos. |
+-------------+----------------------+-----------------------------------------------------+
| p7zip_ | Supported | * Unmaintained? |
| | | * Requires ``p7zip-rar`` package on Debian/Ubuntu. |
+-------------+----------------------+-----------------------------------------------------+
| bsdtar_ | Supported | * Not recommended: limited RAR format support. |
| | | * Does not support multi-volume archives. |
| | | * Does not support solid archives. |
| | | * Does not support password-protected archives. |
| | | * Does not support RARVM-based compression filters. |
+-------------+----------------------+-----------------------------------------------------+
| unrar-free_ | Supported | * Supports output to stdout (v0.2.0). |
| | | * Based on libarchive so similar format support |
| | | as ``bsdtar`` but supports multi-volume (v0.3.0). |
+-------------+----------------------+-----------------------------------------------------+
.. _p7zip: https://sourceforge.net/projects/p7zip/
.. _unrar-free: https://gitlab.com/bgermann/unrar-free
Links:
- `Documentation`_
- `Downloads`_
- `Git`_ repo
.. _Git: https://github.com/markokr/rarfile
.. _Downloads: https://pypi.org/project/rarfile/#files
.. _Documentation: https://rarfile.readthedocs.io/