Skip to main content

portable archive file manager

Project description

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, .cb7), ACE (.ace, .cba), ADF (.adf), ALZIP (.alz), APE (.ape), AR (.a), ARC (.arc), ARJ (.arj), BZIP2 (.bz2), BZIP3 (.bz3), CAB (.cab), CHM (.chm), 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, .cbr), RZIP (.rz), SHN (.shn), TAR (.tar, .cbt), UDF (.udf), XZ (.xz), ZIP (.zip, .jar, .cbz), ZOO (.zoo) and ZSTANDARD (.zst) archive formats.

It relies on helper applications to handle those archive formats (for example xz for XZ (.xz) archives).

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

Examples

# Extract several archives with different formats
patool extract archive.zip otherarchive.rar

# Extract archive with password
patool extract --password somepassword archive.rar

# Test archive integrity
patool test --verbose dist.tar.gz

# List files stored in an archive
patool list package.deb

# Create a new archive
patool create --verbose /path/to/myfiles.zip file1.txt dir/

# Create a new archive with password
patool create --verbose --password somepassword /path/to/myfiles.zip file1.txt dir/

# Show differences between two archives
patool diff release1.0.tar.gz release2.0.zip

# Search for text inside archives
patool search "def urlopen" python-3.3.tar.gz

# Repackage an archive in a different format
patool repack linux-2.6.33.tar.gz linux-2.6.33.tar.bz2

Website

See https://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. Note that extra options or customization for specific archive programs are not supported.

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")
patoolib.is_archive("package.deb")

See https://wummel.github.io/patool/ for detailed API documentation.

Test suite

Patool has extensive unit tests to ensure the code quality. The tests are run on each commit by a github runner.

Bash completion

Install the argcomplete python package with apt-get install python3-argcomplete, then run eval "$(register-python-argcomplete patool)". After that typing patool, a <SPACE> and then <TAB> lists available options and commands.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

patool-4.0.1.tar.gz (2.0 MB view details)

Uploaded Source

Built Distribution

patool-4.0.1-py2.py3-none-any.whl (86.5 kB view details)

Uploaded Python 2Python 3

File details

Details for the file patool-4.0.1.tar.gz.

File metadata

  • Download URL: patool-4.0.1.tar.gz
  • Upload date:
  • Size: 2.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.2

File hashes

Hashes for patool-4.0.1.tar.gz
Algorithm Hash digest
SHA256 41f7ee21be337a5baf07b2cb4796e9d94397ab741d2379c622f98fc001099802
MD5 aec6225bac64590c493c77326b9760fb
BLAKE2b-256 93c7f9d5c6f9c51433d95399e40c9dd214f2b44bdcb79cbbd86028f55535725e

See more details on using hashes here.

File details

Details for the file patool-4.0.1-py2.py3-none-any.whl.

File metadata

  • Download URL: patool-4.0.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 86.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.2

File hashes

Hashes for patool-4.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a7430eb08edcbd71feaf9c40f55c46f6a0ac385dc68dd0f5010cfa4ad2e9341a
MD5 5fcb59b2f1aefc1b152f9f0df7ed89ee
BLAKE2b-256 d207a7aefd5b3ee565b4d959bcf7061666c7fbf66ed83e58d07cdcdca35c9b33

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page