Metadata-Version: 1.0
Name: pyunpack
Version: 0.0.1
Summary: unpack archive files
Home-page: https://github.com/ponty/pyunpack
Author: ponty
Author-email: UNKNOWN
License: BSD
Description: unpack archive files
        
        Links:
         * home: https://github.com/ponty/pyunpack
         * documentation: http://ponty.github.com/pyunpack
          
        Features:
         - unpack archive files without password
         - very simple interface
         - command line interface and library
         - backends: 
            * zipfile_: included in Python
            * patool_: 
              It relies on helper applications to handle those archive formats 
              (for example bzip2 for BZIP2 archives).
              Supported formats:
              7z (.7z), ACE (.ace), ALZIP (.alz), AR (.a), ARC (.arc), ARJ (.arj), 
              BZIP2 (.bz2), CAB (.cab), compress (.Z), CPIO (.cpio), DEB (.deb), 
              DMS (.dms), GZIP (.gz), LRZIP (.lrz), LZH (.lha, .lzh), LZIP (.lz), 
              LZMA (.lzma), LZOP (.lzo), RPM (.rpm), RAR (.rar), RZIP (.rz), 
              TAR (.tar), XZ (.xz), ZIP (.zip, .jar) and ZOO (.zoo)  
         
        Known problems:
         - Python 3 is not supported
         - tested only on linux
        
        Background
        -----------
        
        Patool_ is very good at unpacking a lot of archive formats,
        but it can not be used as a python library.
        pyunpack is a workaround: patool_ is called using its command line interface.
        If Patool_ is not installed then only zip format can be unpacked
        using the internal python zipfile_ library.
        Patool_ should be converted into a library in the future.
         
        Basic usage
        ============
        
            >>> from pyunpack import Archive
            >>> Archive('a.zip').extractall('/path/to')
        
        or on console::
        
            python -m pyunpack.cli a.zip /path/to
        
        
        Similar projects
        ================
        
         * zipfile_: zip only, included in python
         * patool_: many formats, command line only
         * `python-archive <http://pypi.python.org/pypi/python-archive>`_: zip and tar only
         * `rarfile <http://pypi.python.org/pypi/rarfile/>`_: rar only
         * `pyUnRAR2 <http://pypi.python.org/pypi/pyUnRAR2>`_: rar only
         * `pylzma <http://pypi.python.org/pypi/pylzma>`_: LZMA only
         * `easy-extract <http://pypi.python.org/pypi/easy-extract>`_: many formats, no simple interface for unpacking
         * `python-archive <http://pypi.python.org/pypi/python-archive>`_: zip and tar only
         * `pyarchive <http://pypi.python.org/pypi/pyarchive>`_
         * `nested.tar.archives.extractor <http://pypi.python.org/pypi/nested.tar.archives.extractor>`_: tar only
        
        Installation
        ============
        
        General
        --------
        
         * install setuptools_
         * install unpackers for patool_ (optional)
         * patool_ is installed by setup script
         * install the program::
        
            # as root
            easy_install pyunpack
            
        
        
        Ubuntu
        ----------
        ::
        
            sudo apt-get install python-setuptools
            sudo easy_install pyunpack
            #optional
            sudo apt-get install unzip unrar p7zip-full
        
        Uninstall
        ----------
        
        first install pip_::
        
            # as root
            pip uninstall pyunpack
        
        
        .. _setuptools: http://peak.telecommunity.com/DevCenter/EasyInstall
        .. _pip: http://pip.openplans.org/
        .. _python: http://www.python.org/
        .. _patool: http://pypi.python.org/pypi/patool
        .. _zipfile: http://docs.python.org/library/zipfile.html
Keywords: unpack archive
Platform: UNKNOWN
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
