Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

Command line utilities for creating zip files

Project description

zip-files

Source code on Github zip-files on the Python Package Index Travis Continuous Integration AppVeyor Continuous Integration Coveralls BSD License

Command line utilities for creating zip files.

Provides the zip-files and zip-folder command line utilities. These are intended as an easy platform-independent tool to create zip files with an arbitrary file name and an arbitrary root (the top-level folder after extracting a zip) from files and folders at arbitrary locations on the file system.

Typical usage includes:

  • Deploy zip archives of Sphinx-documentation while releasing Python packages:

    zip-folder --auto-root --outfile docs/_build/artifacts/mypackage-v1.0.0.zip docs/_build/html
    

    creates a file mypackage-v1.0.0.zip in docs/_build/artifacts that unzips as a folder mypackage-v1.0.0 containing the files originally in docs/_build/html/.

  • Create zip files pulled together from different locations, for emailing:

    zip-files -a -o report.zip ./report2020-01.tex /scratch/project/plots/*.pdf
    

    creates a file report.zip that unzips as a folder report containing the file report2020-01.tex and all the pdf files originally in /scratch/project/plots/.

    zip-files -f report2020-01 -o report.zip ./report2020-01.tex /scratch/project/plots/*.pdf
    

    does the same, but unzips as a folder report2020-01 instead of report.

Development of zip-files happens on Github.

Installation

To install the latest released version of zip-files, run this command in your terminal:

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 environment’s bin folder.

Usage

zip-files

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 ROOT_FOLDER   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]
  -a, --auto-root                 If given in combination with --outfile, use
                                  the stem of the OUTFILE (without path and
                                  extension) as the value for ROOT_FOLDER
  -x, --exclude GLOB_PATTERN      Glob-pattern to exclude. This is matched
                                  from the right against all paths in the zip
                                  file, see Python pathlib's Path.match
                                  method. This option can be given multiple
                                  times.
  --exclude-dotfiles / --include-dotfiles
                                  Whether or not to include dotfiles in the
                                  zip files. By default, dotfiles are
                                  included.
  -o, --outfile OUTFILE           The path of the zip file to be written. By
                                  default, the file is written to stdout.

zip-folder

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 ROOT_FOLDER   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]
  -a, --auto-root                 If given in combination with --outfile, use
                                  the stem of the OUTFILE (without path and
                                  extension) as the value for ROOT_FOLDER
  -x, --exclude GLOB_PATTERN      Glob-pattern to exclude. This is matched
                                  from the right against all paths in the zip
                                  file, see Python pathlib's Path.match
                                  method. This option can be given multiple
                                  times.
  --exclude-dotfiles / --include-dotfiles
                                  Whether or not to include dotfiles in the
                                  zip files. By default, dotfiles are
                                  included.
  -o, --outfile OUTFILE           The path of the zip file to be written. By
                                  default, the file is written to stdout.

History

0.3.0 (2020-01-19)

  • Added: option --exclude

0.2.0 (2020-01-17)

  • Added: option --auto-root

0.1.0 (2020-01-17)

  • Initial release

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 zip-files, version 0.3.0
Filename, size File type Python version Upload date Hashes
Filename, size zip_files-0.3.0-py2.py3-none-any.whl (9.3 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size zip_files-0.3.0.tar.gz (35.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page