-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.txt
46 lines (33 loc) · 1.32 KB
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
==============
python-archive
==============
This package provides a simple, pure-Python interface for handling various
archive file formats. Currently, archive extraction is the only supported
action. Supported file formats include:
* Zip formats and equivalents: ``.zip``, ``.egg``, ``.jar``.
* Tar and compressed tar formats: ``.tar``, ``.tar.gz``, ``.tgz``,
``.tar.bz2``, ``.tz2``.
Example usage
=============
Using the ``Archive`` class::
from archive import Archive
a = Archive('files.tar.gz')
a.extract()
Using the ``extract`` convenience function::
from archive import extract
# Extract in current directory.
extract('files.tar.gz')
# Extract in directory 'unpack_dir'.
extract('files.tar.gz', 'unpack_dir')
Note that calling extract with ``safe=True`` will ensure that the archive is
safe prior to extraction: ``UnsafeArchive`` exception will be raised when
archive contains paths which would be extracted outside of the target
directory (e.g. absolute paths)::
# Safely extract in directory 'unpack_dir'.
extract('files.tar.gz', 'unpack_dir', safe=True)
Similar tools
=============
* http://pypi.python.org/pypi/patool/ - portable command line archive file
manager.
* http://pypi.python.org/pypi/gocept.download/ - zc.buildout recipe for
downloading and extracting an archive.