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
--excludepatterns --dry-runmode for safe previewing- Informative
--summaryand--infoflags - Customize zip structure via
--zip-type
License
MIT License
Author
Zubin Palit
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file zipit_cli-1.0.0a1.tar.gz.
File metadata
- Download URL: zipit_cli-1.0.0a1.tar.gz
- Upload date:
- Size: 5.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
02d6bda01d124d6c35d5ab2f4eb84e3c257a6ff410028ca7c73734affb74269e
|
|
| MD5 |
2ba0f709de9585b0a77883ce0581290e
|
|
| BLAKE2b-256 |
81f7318ce5d4e3e34f4b21f9dcbaa05d408f153948499d0ffecccdc1a2e849e6
|
File details
Details for the file zipit_cli-1.0.0a1-py3-none-any.whl.
File metadata
- Download URL: zipit_cli-1.0.0a1-py3-none-any.whl
- Upload date:
- Size: 5.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4b60b67df8dfef33bc783f8dfc09d1aa7efef34aa4712812f5da7a092a393939
|
|
| MD5 |
79e43b57b567ebc9886255ca4c0962ad
|
|
| BLAKE2b-256 |
c028ca0cf3779515e8193a395287e6950ed0181fd97159df96d9ed5c8885bc5d
|