Skip to main content

Wrapper around tarfile with support for more compression formats.

Project description

https://github.com/ascoderu/xtarfile/workflows/CI/badge.svg https://img.shields.io/pypi/v/xtarfile.svg

Overview

Wrapper around tarfile to add support for more compression formats.

Usage

First, install the library with the tarfile compression formats you wish to support. The example below shows an install for zstandard tarfile support.

pip install xtarfile[zstd]

You can now use the xtarfile module in the same way as the standard library tarfile module:

import xtarfile as tarfile

with tarfile.open('some-archive', 'w:zstd') as archive:
    archive.add('a-file.txt')

with tarfile.open('some-archive', 'r:zstd') as archive:
    archive.extractall()

Alternatively, detecting the correct compression module based on the file extensions is also supported:

import xtarfile as tarfile

with tarfile.open('some-archive.tar.zstd', 'w') as archive:
    archive.add('a-file.txt')

with tarfile.open('some-archive.tar.zstd', 'r') as archive:
    archive.extractall()

Development

Install the project’s dependencies with pip install .[zstd].

Run the tests via python3 setup.py test.

Project details


Download files

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

Files for xtarfile, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size xtarfile-0.1.0.tar.gz (3.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page