Go to file

Bastian Kleineidam a76e54f238 Add API docs. [ci skip]		2013-05-06 20:43:02 +02:00
doc	Add API docs.	2013-05-06 20:43:02 +02:00
patoolib	Fix Python 3.2	2013-04-08 20:20:26 +02:00
scripts	Add app dir to PATH.	2013-02-28 07:34:51 +01:00
tests	Add support for zopfli.	2013-03-28 19:42:50 +01:00
.gitattributes	Add web page source.	2013-03-29 11:12:37 +01:00
.gitignore	Generate metadata as python module.	2013-04-08 20:12:50 +02:00
.travis.yml	Do not store local testresults on Travis run.	2013-02-27 19:39:09 +01:00
COPYING	Initial commit	2010-02-21 12:14:57 +01:00
MANIFEST.in	Add help entry and set PATH in windows installer.	2013-02-28 21:20:33 +01:00
Makefile	Close bugs on release.	2013-04-11 18:29:01 +02:00
README.md	Add readme	2012-12-13 21:34:57 +01:00
install-rpm.sh	Fix RPM installation.	2012-04-11 18:21:22 +02:00
patool	Generate metadata as python module.	2013-04-08 20:12:50 +02:00
patool.bash-completion	Use python-argcompletion.	2013-02-27 20:55:24 +01:00
patool.freecode	Remove relase focus	2013-04-21 14:27:38 +02:00
requirements.txt	Add travis CI info.	2013-02-21 17:53:16 +01:00
setup.cfg	Bump up version and update author email.	2013-02-22 18:33:08 +01:00
setup.py	Remove old download url.	2013-04-14 23:04:01 +02:00

README.md

Patool

Patool is an archive file manager.

Various archive formats can be created, extracted, tested, listed, searched, repacked and compared with patool. The advantage of patool is its simplicity in handling archive files without having to remember a myriad of programs and options.

The archive format is determined by the file(1) program and as a fallback by the archive file extension.

patool supports 7z (.7z), ACE (.ace), ADF (.adf), ALZIP (.alz), APE (.ape), AR (.a), ARC (.arc), ARJ (.arj), BZIP2 (.bz2), CAB (.cab), COMPRESS (.Z), CPIO (.cpio), DEB (.deb), DMS (.dms), FLAC (.flac), GZIP (.gz), ISO (.iso), LRZIP (.lrz), LZH (.lha, .lzh), LZIP (.lz), LZMA (.lzma), LZOP (.lzo), RPM (.rpm), RAR (.rar), RZIP (.rz), SHN (.shn), TAR (.tar), XZ (.xz), ZIP (.zip, .jar) and ZOO (.zoo) formats. It relies on helper applications to handle those archive formats (for example bzip2 for BZIP2 archives).

The archive formats TAR, ZIP, BZIP2 and GZIP are supported natively and do not require helper applications to be installed.

Examples

patool extract archive.zip otherarchive.rar
patool test --verbose dist.tar.gz
patool list package.deb
patool create --verbose /path/to/myfiles.zip file1.txt dir/
patool diff release1.0.tar.gz release2.0.zip
patool search "def urlopen" python-3.3.tar.gz
patool repack linux-2.6.33.tar.gz linux-2.6.33.tar.bz2

Website

See http://wummel.github.io/patool/ for more info and downloads.

API

You can use patool functions from other Python applications. Log output will be on sys.stdout and sys.stderr. On errors, PatoolError will be raised.

import patoolib
patoolib.extract_archive("archive.zip", outdir="/tmp")
patoolib.test_archive("dist.tar.gz", verbosity=1)
patoolib.list_archive("package.deb")
patoolib.create_archive("/path/to/myfiles.zip", ("file1.txt", "dir/"))
patoolib.diff_archives("release1.0.tar.gz", "release2.0.zip")
patoolib.search_archive("def urlopen", "python3.3.tar.gz")
patoolib.repack_archive("linux-2.6.33.tar.gz", "linux-2.6.33.tar.bz2")

Test suite status

Patool has extensive unit tests to ensure the code quality. Travis CI is used for continuous build and test integration.