Skip to main content

A smart zip tool that respects .gitignore and custom patterns

Project description

zipit-cli

zipit-cli is a lightweight command-line tool that zips your current directory, while automatically respecting your .gitignore file and any custom exclusions you provide. It is perfect for packaging projects, excluding unwanted files like build artifacts, logs, or virtual environments.


Installation

To install the package from PyPI:

pip install zipit-cli

This will install a CLI command called zipit.


Usage

Basic usage:

zipit

Zips the current directory, using the folder name as the output zip file.


Common Options

Flag Description
--name Specify a custom name for the zip file
--verbose Show detailed log of what is being zipped or skipped
--dry-run Simulate without creating the zip file
--exclude Glob-style patterns to exclude (e.g., *.log, temp/)
--summary Show a summary with file counts, size, and types
--info Display the config info and exit
--zip-type Control folder structure inside zip: outer (default) or inner

Examples

zipit --name release.zip
zipit --exclude "*.log" "__pycache__/" --summary
zipit --dry-run --verbose
zipit --zip-type inner
zipit --zip-type outer
zipit --info

What is --zip-type?

--zip-type ZIP Structure
outer project_folder.zip > project_folder > files
inner project_folder.zip > files (no project folder)

Features

  • Automatically respects .gitignore
  • Supports additional --exclude patterns
  • --dry-run mode for safe previewing
  • Informative --summary and --info flags
  • Customize zip structure via --zip-type

License

MIT License


Author

Zubin Palit

Project details


Download files

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

Source Distribution

zipit_cli-1.0.0b1.tar.gz (5.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

zipit_cli-1.0.0b1-py3-none-any.whl (5.9 kB view details)

Uploaded Python 3

File details

Details for the file zipit_cli-1.0.0b1.tar.gz.

File metadata

  • Download URL: zipit_cli-1.0.0b1.tar.gz
  • Upload date:
  • Size: 5.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.11

File hashes

Hashes for zipit_cli-1.0.0b1.tar.gz
Algorithm Hash digest
SHA256 1f20990a2965b89126f4a756c46ab65b8eeecd9c95fed724715380e50588ad12
MD5 eb183f2e932cb54425a911380cf46385
BLAKE2b-256 0f8916e024957c057ff4f3ee69ec2cdd464c980c4d8b366c26a85ad57d552d24

See more details on using hashes here.

File details

Details for the file zipit_cli-1.0.0b1-py3-none-any.whl.

File metadata

  • Download URL: zipit_cli-1.0.0b1-py3-none-any.whl
  • Upload date:
  • Size: 5.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.11

File hashes

Hashes for zipit_cli-1.0.0b1-py3-none-any.whl
Algorithm Hash digest
SHA256 f7917c5baf4ea415fd45acf37eac9fe8a063999da68938c064f084e3f138c73c
MD5 fa759c46b9e604dc284f33ec49ab88fb
BLAKE2b-256 91374674ec21180c0a9754d9cf7aa52738ada9bd1725153697b7ea55dad9c897

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page