Metadata-Version: 2.1
Name: zip-files
Version: 0.1.0
Summary: Command line utilities for creating zip files
Home-page: https://github.com/goerz/zip_files
Author: Michael Goerz
Author-email: mail@michaelgoerz.net
License: BSD license
Description: =========
        zip-files
        =========
        
        .. image:: https://img.shields.io/badge/github-goerz/zip__files-blue.svg
           :alt: Source code on Github
           :target: https://github.com/goerz/zip_files
        
        .. image:: https://img.shields.io/pypi/v/zip_files.svg
           :alt: zip-files on the Python Package Index
           :target: https://pypi.python.org/pypi/zip_files
        
        .. image:: https://img.shields.io/travis/goerz/zip_files.svg
           :alt: Travis Continuous Integration
           :target: https://travis-ci.org/goerz/zip_files
        
        .. image:: https://ci.appveyor.com/api/projects/status/k2lqxw97gv2m9gpm/branch/master?svg=true
           :alt: AppVeyor Continuous Integration
           :target: https://ci.appveyor.com/project/goerz/zip-files
        
        .. image:: https://img.shields.io/coveralls/github/goerz/zip_files/master.svg
           :alt: Coveralls
           :target: https://coveralls.io/github/goerz/zip_files?branch=master
        
        .. image:: https://img.shields.io/badge/License-BSD-green.svg
           :alt: BSD License
           :target: https://opensource.org/licenses/BSD-3-Clause
        
        Command line utilities for creating zip files.
        
        Development of zip-files happens on `Github`_.
        
        
        Installation
        ------------
        
        To install the latest released version of zip-files, run this command in your terminal:
        
        .. code-block:: shell
        
            pip install zip_files
        
        This is the preferred method to install zip-files, as it will always install the most recent stable release.
        It will result in the executable commands `zip-files` and `zip-folder` being
        added to your environments ``bin`` folder.
        
        .. _Github: https://github.com/goerz/zip_files
        
        
        Usage
        -----
        
        zip-files
        ~~~~~~~~~
        
        .. code-block:: console
        
        
            Usage: zip-files [OPTIONS] [FILES]...
        
              Create a zip file containing FILES.
        
            Options:
              -h, --help                      Show this message and exit.
              --version                       Show the version and exit.
              --debug                         Activate debug logging.
              -f, --root-folder TEXT          Folder name to prepend to FILES inside the
                                              zip file.
              -c, --compression [stored|deflated|bzip2|lzma]
                                              Zip compression method. The following
                                              methods are available: "stored": no
                                              compression; "deflated": the standard zip
                                              compression method; "bzip2": BZIP2
                                              compression method (part of the zip standard
                                              since 2001); "lzma": LZMA compression method
                                              (part of the zip standard since 2006).
                                              [default: deflated]
              -o, --outfile TEXT              The path of the zip file to be written. By
                                              default, the file is written to stdout.
        
        zip-folder
        ~~~~~~~~~~
        
        .. code-block:: console
        
            Usage: zip-folder [OPTIONS] FOLDER
        
              Create a zip file containing the FOLDER.
        
            Options:
              -h, --help                      Show this message and exit.
              --version                       Show the version and exit.
              --debug                         Activate debug logging.
              -f, --root-folder TEXT          Folder name to use as the top level folder
                                              inside the zip file (replacing FOLDER).
              -c, --compression [stored|deflated|bzip2|lzma]
                                              Zip compression method. The following
                                              methods are available: "stored": no
                                              compression; "deflated": the standard zip
                                              compression method; "bzip2": BZIP2
                                              compression method (part of the zip standard
                                              since 2001); "lzma": LZMA compression method
                                              (part of the zip standard since 2006).
                                              [default: deflated]
              -o, --outfile TEXT              The path of the zip file to be written. By
                                              default, the file is written to stdout.
        
        
        =======
        History
        =======
        
        0.1.0 (2020-01-17)
        ------------------
        
        * Initial release
        
Keywords: zip_files
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: BSD License
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: System :: Archiving :: Compression
Classifier: Topic :: System :: Archiving :: Packaging
Classifier: Topic :: Utilities
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Environment :: Console
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
Provides-Extra: dev
