| Name | py-zippy JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | Archive Utility Toolkit supporting multi-format workflows, password recovery, and repair helpers. |
| upload_time | 2025-10-11 20:41:46 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License
Copyright (c) 2025 John H. Mitander
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
|
| keywords |
archives
zip
tar
cli
toolkit
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
colorama
python-dotenv
pyzipper
patool
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align="center">
# Zippy
**Multi-purpose archive extraction, repair and brute-force toolkit.**
</div>
    
```bash
- **Broad format coverage** - (`tar`, `tar.gz`, `tar.bz2`, `tar.xz`, `tar.lzma`), (`gzip`, `bz2`, `xz`, `lzma`), `7z`, `rar`, `zstd` and ZIP family (including APK/JAR/WAR/IPA/EAR).
- **Consistent UX** - consistent logging, progress indicators, and tab completion for every command.
- **Security tooling** - create or re-lock encrypted ZIPs, run smart dictionary attacks with the bundled password list, and capture verbose traces when needed.
- **Integrity & repair** - repair, attempt salvage extractions, and perform best-effort recovery for TAR and single-file formats. It grabs whatever it can, even if files look broken or corrupted. This is achieved by scanning the archive for valid headers and footers, and extracting the data in between, then rebuilding the file structure using advanced data pointers and heuristics.
## Installation
### From PyPI (recommended)
```bash
python -m pip install zippy
```
### From source
```bash
git clone https://github.com/John0n1/ZIPPY.git
cd ZIPPY
python -m pip install .
### Debian package
```bash
sudo apt install ./zippy_*.deb
```
## Quick start
```bash
# Extract an archive
zippy --extract backups/site.tar.xz -o ./site
# Create a password-protected ZIP from multiple paths
zippy --lock secure.zip -f docs,images -p "Tru5ted!"
# List TAR.BZ2 contents
zippy --list datasets.tar.bz2
# Attempt unlocking with the bundled wordlist
zippy --unlock encrypted.zip -d password_list.txt --verbose
# Run salvage repair on a damaged tarball
zippy --repair broken.tar.gz --repair-mode remove_corrupted
```
Run `zippy --help` for the full command reference or `zippy --version` to confirm the installed release.
## Supported archive formats
| Family | Types |
| ------ | ----- |
| ZIP | `zip` (with optional password protection) |
| TAR | `tar`, `tar.gz`, `tar.bz2`, `tar.xz`, `tar.lzma`, `.tgz`, `.tbz`, `.txz`, `.tlz` |
| Single-file | `gzip` (`.gz`), `bz2` (`.bz2`), `xz` (`.xz`), `lzma` (`.lzma`) |
Unsupported formats (e.g. 7z, rar, zstd) will raise a friendly error instructing you to choose a supported type.
## Configuration & automation
- Use `--save-config <file>` to capture the current flag set (including passwords or dictionary paths if provided).
- Rehydrate saved flags via `--load-config <file>` for repeatable batch jobs.
- Disable animations with `--no-animation` for CI environments.
## Logging & colours
Logging defaults to concise `INFO` output. Add `--verbose` for `DEBUG` traces. Colour output automatically downgrades in non-interactive terminals, while animations fall back to plain log messages when disabled or redirected. Windows terminals are supported through `colorama`.
## Password dictionary
The bundled `password_list.txt` contains hundreds of common credentials, curated for demonstration purposes. The unlock command trims duplicates, ignores comments (`# ...`), and safely handles mixed encodings. Supply your own list with `--dictionary <file>` for larger attacks.
## Contributing
Pull requests are welcome—please open an issue describing the enhancement before submitting substantial changes.
## License
Zippy is released under the MIT License. See `LICENSE` for the full text.
## Disclaimer
Zippy is provided "as is" without warranty of any kind. Use at your own risk and keep backups of critical data.
**The author is not responsible for any data loss or damage resulting from the use of this software.**
Raw data
{
"_id": null,
"home_page": null,
"name": "py-zippy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "archives, zip, tar, cli, toolkit",
"author": null,
"author_email": "John Hauger Mitander <john@on1.no>",
"download_url": "https://files.pythonhosted.org/packages/da/d6/dd08e403c0e5071ca3a43929537633048aa5b462849ef3344ee1ac7a9500/py_zippy-1.0.0.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n# Zippy\n\n**Multi-purpose archive extraction, repair and brute-force toolkit.**\n\n</div>\n\n    \n\n```bash\n\n- **Broad format coverage** - (`tar`, `tar.gz`, `tar.bz2`, `tar.xz`, `tar.lzma`), (`gzip`, `bz2`, `xz`, `lzma`), `7z`, `rar`, `zstd` and ZIP family (including APK/JAR/WAR/IPA/EAR).\n- **Consistent UX** - consistent logging, progress indicators, and tab completion for every command.\n- **Security tooling** - create or re-lock encrypted ZIPs, run smart dictionary attacks with the bundled password list, and capture verbose traces when needed.\n- **Integrity & repair** - repair, attempt salvage extractions, and perform best-effort recovery for TAR and single-file formats. It grabs whatever it can, even if files look broken or corrupted. This is achieved by scanning the archive for valid headers and footers, and extracting the data in between, then rebuilding the file structure using advanced data pointers and heuristics.\n\n## Installation\n\n### From PyPI (recommended)\n\n```bash\npython -m pip install zippy\n```\n\n### From source\n\n```bash\ngit clone https://github.com/John0n1/ZIPPY.git\ncd ZIPPY\npython -m pip install .\n\n### Debian package\n\n```bash\nsudo apt install ./zippy_*.deb\n```\n\n## Quick start\n\n```bash\n# Extract an archive\nzippy --extract backups/site.tar.xz -o ./site\n\n# Create a password-protected ZIP from multiple paths\nzippy --lock secure.zip -f docs,images -p \"Tru5ted!\"\n\n# List TAR.BZ2 contents\nzippy --list datasets.tar.bz2\n\n# Attempt unlocking with the bundled wordlist\nzippy --unlock encrypted.zip -d password_list.txt --verbose\n\n# Run salvage repair on a damaged tarball\nzippy --repair broken.tar.gz --repair-mode remove_corrupted\n```\n\nRun `zippy --help` for the full command reference or `zippy --version` to confirm the installed release.\n\n## Supported archive formats\n\n| Family | Types |\n| ------ | ----- |\n| ZIP | `zip` (with optional password protection) |\n| TAR | `tar`, `tar.gz`, `tar.bz2`, `tar.xz`, `tar.lzma`, `.tgz`, `.tbz`, `.txz`, `.tlz` |\n| Single-file | `gzip` (`.gz`), `bz2` (`.bz2`), `xz` (`.xz`), `lzma` (`.lzma`) |\n\nUnsupported formats (e.g. 7z, rar, zstd) will raise a friendly error instructing you to choose a supported type.\n\n## Configuration & automation\n\n- Use `--save-config <file>` to capture the current flag set (including passwords or dictionary paths if provided).\n- Rehydrate saved flags via `--load-config <file>` for repeatable batch jobs.\n- Disable animations with `--no-animation` for CI environments.\n\n## Logging & colours\n\nLogging defaults to concise `INFO` output. Add `--verbose` for `DEBUG` traces. Colour output automatically downgrades in non-interactive terminals, while animations fall back to plain log messages when disabled or redirected. Windows terminals are supported through `colorama`.\n\n## Password dictionary\n\nThe bundled `password_list.txt` contains hundreds of common credentials, curated for demonstration purposes. The unlock command trims duplicates, ignores comments (`# ...`), and safely handles mixed encodings. Supply your own list with `--dictionary <file>` for larger attacks.\n\n## Contributing\nPull requests are welcome\u2014please open an issue describing the enhancement before submitting substantial changes.\n\n## License\n\nZippy is released under the MIT License. See `LICENSE` for the full text.\n\n## Disclaimer\n\nZippy is provided \"as is\" without warranty of any kind. Use at your own risk and keep backups of critical data.\n\n**The author is not responsible for any data loss or damage resulting from the use of this software.**\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2025 John H. Mitander\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "Archive Utility Toolkit supporting multi-format workflows, password recovery, and repair helpers.",
"version": "1.0.0",
"project_urls": {
"Documentation": "https://github.com/John0n1/ZIPPY#readme",
"Homepage": "https://github.com/John0n1/ZIPPY",
"Issues": "https://github.com/John0n1/ZIPPY/issues"
},
"split_keywords": [
"archives",
" zip",
" tar",
" cli",
" toolkit"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "cce77b272b107763d86cd27a891d7bbabd289a6eaa0ebe6074ef875e7549d8e1",
"md5": "0432817bc27ec67de2be9988572f2e15",
"sha256": "64ca8d74deb6567772a12fee6cfd35b77d272b90c7968114e4bdfe23176d1817"
},
"downloads": -1,
"filename": "py_zippy-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0432817bc27ec67de2be9988572f2e15",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 23349,
"upload_time": "2025-10-11T20:41:44",
"upload_time_iso_8601": "2025-10-11T20:41:44.726143Z",
"url": "https://files.pythonhosted.org/packages/cc/e7/7b272b107763d86cd27a891d7bbabd289a6eaa0ebe6074ef875e7549d8e1/py_zippy-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "dad6dd08e403c0e5071ca3a43929537633048aa5b462849ef3344ee1ac7a9500",
"md5": "60bf899b627dbffc34ec1660b68b3874",
"sha256": "a5ff6d805bf47d802d11c4025b2d9329a4be87f51dfaebcbe09c4a06f6d39dc1"
},
"downloads": -1,
"filename": "py_zippy-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "60bf899b627dbffc34ec1660b68b3874",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 16704,
"upload_time": "2025-10-11T20:41:46",
"upload_time_iso_8601": "2025-10-11T20:41:46.203440Z",
"url": "https://files.pythonhosted.org/packages/da/d6/dd08e403c0e5071ca3a43929537633048aa5b462849ef3344ee1ac7a9500/py_zippy-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-11 20:41:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "John0n1",
"github_project": "ZIPPY#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "colorama",
"specs": [
[
">=",
"0.4.6"
]
]
},
{
"name": "python-dotenv",
"specs": [
[
">=",
"1.0"
]
]
},
{
"name": "pyzipper",
"specs": [
[
">=",
"0.3.6"
]
]
},
{
"name": "patool",
"specs": [
[
">=",
"1.12"
]
]
}
],
"lcname": "py-zippy"
}
