README

   1
   2 rarfile - Rar archive reader for Python
   3 =======================================
   4
   5 1.  Description
   6 ----------------
   7
   8 This is Python module for Rar archive reading.  The interface
   9 is made as `zipfile` like as possible.
  10
  11 Features:
  12
  13 - Supports RAR 3.x archives.
  14 - Supports multi volume archives.
  15 - Supports Unicode filenames.
  16 - Supports password-protected archives.
  17 - Supports archive comments.
  18 - Handles non-compressed files without outside help.
  19 - For compressed files runs `unrar` utility.
  20
  21
  22 2. Documentation
  23 ----------------
  24
  25 http://rarfile.berlios.de/doc/[]
  26
  27 3. History
  28 ----------
  29
  30 Version 2.0 (2010-04-29)
  31 ~~~~~~~~~~~~~~~~~~~~~~~~
  32
  33 Features::
  34  * Python 3 support.  Still works with 2.x.
  35  * Parses extended time fields. (.mtime, .ctime, .atime)
  36  * .open() method.  This makes possible to process large
  37    entries that do not fit into memory.
  38  * Supports password-protected archives.
  39  * Supports archive comments.
  40
  41 Cleanups::
  42  * Uses subprocess module to launch unrar.
  43  * .filename is always Unicode string, .unicode_filename is now deprecated.
  44  * .CRC is unsigned again, as python3 crc32() is unsigned.
  45
  46 Version 1.1 (2008-08-31)
  47 ~~~~~~~~~~~~~~~~~~~~~~~~
  48
  49 Fixes::
  50  * Replace os.tempnam() with tempfile.mkstemp().  (Jason Moiron)
  51  * Fix infinite loop in _extract_hack on unexpected EOF
  52  * RarInfo.CRC is now signed value to match crc32()
  53  * RarFile.read() now checks file crc
  54
  55 Cleanups::
  56  * more docstrings
  57  * throw proper exceptions (subclasses of rarfile.Error)
  58  * RarInfo has fields pre-initialized, so they appear in help()
  59  * rename RarInfo.data to RarInfo.header_data
  60  * dont use "print" when header parsing fails
  61  * use try/finally to delete temp rar
  62
  63 Version 1.0 (2005-08-08)
  64 ~~~~~~~~~~~~~~~~~~~~~~~~
  65
  66  * First release.
  67