README.rst

   1
   2 rarfile - RAR archive reader for Python
   3 =======================================
   4
   5 This is Python module for RAR_ archive reading.  The interface
   6 is made as zipfile_ like as possible.  Licensed under ISC_
   7 license.
   8
   9 Features:
  10
  11 - Supports both RAR3 and RAR5 format archives.
  12 - Supports multi volume archives.
  13 - Supports Unicode filenames.
  14 - Supports password-protected archives.
  15 - Supports archive and file comments.
  16 - Archive parsing and non-compressed files are handled in pure Python code.
  17 - Compressed files are extracted by executing external tool: either ``unrar``
  18   from RARLAB_ or ``bsdtar`` from libarchive_.
  19 - Works with both Python 2.7 and 3.x.
  20
  21 Links:
  22
  23 - `Documentation`_
  24 - `Downloads`_
  25 - `Git`_ repo
  26
  27 .. _Git: https://github.com/markokr/rarfile
  28 .. _Downloads: https://pypi.python.org/pypi/rarfile
  29 .. _Documentation: https://rarfile.readthedocs.io/
  30 .. _RAR: https://en.wikipedia.org/wiki/RAR_%28file_format%29
  31 .. _zipfile: https://docs.python.org/2/library/zipfile.html
  32 .. _ISC: https://en.wikipedia.org/wiki/ISC_license
  33 .. _libarchive: https://github.com/libarchive/libarchive
  34 .. _RARLAB: http://www.rarlab.com/