README.rst

   1
   2 rarfile - RAR archive reader for Python
   3 =======================================
   4
   5 This is Python module for RAR_ archive reading.
   6 The interface follows the style of zipfile_.
   7 Licensed under ISC_ 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:
  18   unrar_ (preferred), unar_ or bsdtar_.
  19 * Works with Python 3.6+.
  20
  21 .. _RAR: https://en.wikipedia.org/wiki/RAR_%28file_format%29
  22 .. _zipfile: https://docs.python.org/3/library/zipfile.html
  23 .. _ISC: https://en.wikipedia.org/wiki/ISC_license
  24 .. _bsdtar: https://github.com/libarchive/libarchive
  25 .. _unrar: https://www.rarlab.com/
  26 .. _unar: https://theunarchiver.com/command-line
  27
  28 Links:
  29
  30 - `Documentation`_
  31 - `Downloads`_
  32 - `Git`_ repo
  33
  34 .. _Git: https://github.com/markokr/rarfile
  35 .. _Downloads: https://pypi.org/project/rarfile/#files
  36 .. _Documentation: https://rarfile.readthedocs.io/
  37