Metadata-Version: 2.1
Name: xtarfile
Version: 0.0.4
Summary: Wrapper around tarfile with support for more compression formats.
Home-page: https://github.com/ascoderu/xtarfile
Author: Clemens Wolff
Author-email: clemens.wolff+pypi@gmail.com
License: Apache Software License
Download-URL: https://pypi.python.org/pypi/xtarfile
Description: xtarfile
        ========
        
        .. image:: https://api.travis-ci.org/ascoderu/xtarfile.svg?branch=master
            :target: https://travis-ci.org/ascoderu/xtarfile
        
        .. image:: https://img.shields.io/pypi/v/xtarfile.svg
            :target: https://pypi.org/project/xtarfile/
        
        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.
        
        .. sourcecode :: bash
        
            pip install xtarfile[zstd]
        
        You can now use the xtarfile module in the same way as the standard library tarfile module:
        
        .. sourcecode :: python
        
            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:
        
        .. sourcecode :: python
        
            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 :code:`pip install .[zstd]`.
        
        Run the tests via :code:`python3 setup.py test`.
Platform: UNKNOWN
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Utilities
Requires-Python: >=3.4
Provides-Extra: zstd
