| Name | compresslib JSON |
| Version |
0.1.2
JSON |
| download |
| home_page | None |
| Summary | None |
| upload_time | 2024-06-27 13:18:43 |
| maintainer | None |
| docs_url | None |
| author | John Smith |
| requires_python | <4.0,>=3.10 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
**Compressor CLI Documentation**
=============================
Overview
--------
The Compressor CLI is a command-line interface for compressing and decompressing files using various algorithms. Currently, it supports Huffman Coding and LZW (Lempel-Ziv-Welch) algorithms. This tool is designed to be easy to use for both beginners and experienced users.
Commands
--------
### 1. Compression (`cmp`)
Compresses the specified file using the chosen algorithm.
#### Usage:
```
zipper cmp [OPTIONS] PATH
```
#### Arguments:
* `PATH`: The path of the file to be compressed. This argument is required.
#### Options:
* `--algorithm`, `-a`: The algorithm to be used for compression. Supported values are `huff` for Huffman Coding and `lzw` for Lempel-Ziv-Welch. This option is required.
#### Example:
```
zipper cmp -a lzw /path/to/file
```
### 2. Decompression (`ucmp`)
Decompresses the specified file.
#### Usage:
```
zipper ucmp [OPTIONS] PATH
```
#### Arguments:
* `PATH`: The path of the file to be decompressed. The file must have a `.lzw` or `.huff` extension. This argument is required.
#### Options:
* `--output`, `-o`: The path of the output file or directory. If not specified, the decompressed file will be placed in the same directory as the input file.
#### Example:
```
zipper ucmp /path/to/file.lzw -o /path/to/output
```
Handling Errors
--------------
The CLI is designed to handle errors gracefully. If an error occurs during compression or decompression, the CLI will display an error message. Additionally, users have the option to automatically generate an issue link with the error details, which can be sent to the developers for further assistance.
#### Example:
```
Would you like to send issue? [y/N]: y
```
Contributing
------------
Contributions to the Compressor CLI are welcome. Please refer to the project's CONTRIBUTING guide for more details on how to contribute.
License
-------
The Compressor CLI is licensed under the MIT License. See the LICENSE file for more details.
Raw data
{
"_id": null,
"home_page": null,
"name": "compresslib",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "John Smith",
"author_email": "john@example.com",
"download_url": "https://files.pythonhosted.org/packages/c8/56/1852743cce97998e07d2f0f1d6a90f0e48fbbdb19a5d9a0b0d97b26e6c00/compresslib-0.1.2.tar.gz",
"platform": null,
"description": "**Compressor CLI Documentation**\n=============================\n\nOverview\n--------\n\nThe Compressor CLI is a command-line interface for compressing and decompressing files using various algorithms. Currently, it supports Huffman Coding and LZW (Lempel-Ziv-Welch) algorithms. This tool is designed to be easy to use for both beginners and experienced users.\n\nCommands\n--------\n\n### 1. Compression (`cmp`)\n\nCompresses the specified file using the chosen algorithm.\n\n#### Usage:\n```\nzipper cmp [OPTIONS] PATH\n```\n\n#### Arguments:\n\n* `PATH`: The path of the file to be compressed. This argument is required.\n\n#### Options:\n\n* `--algorithm`, `-a`: The algorithm to be used for compression. Supported values are `huff` for Huffman Coding and `lzw` for Lempel-Ziv-Welch. This option is required.\n\n#### Example:\n```\nzipper cmp -a lzw /path/to/file\n```\n\n### 2. Decompression (`ucmp`)\n\nDecompresses the specified file.\n\n#### Usage:\n```\nzipper ucmp [OPTIONS] PATH\n```\n\n#### Arguments:\n\n* `PATH`: The path of the file to be decompressed. The file must have a `.lzw` or `.huff` extension. This argument is required.\n\n#### Options:\n\n* `--output`, `-o`: The path of the output file or directory. If not specified, the decompressed file will be placed in the same directory as the input file.\n\n#### Example:\n```\nzipper ucmp /path/to/file.lzw -o /path/to/output\n```\n\nHandling Errors\n--------------\n\nThe CLI is designed to handle errors gracefully. If an error occurs during compression or decompression, the CLI will display an error message. Additionally, users have the option to automatically generate an issue link with the error details, which can be sent to the developers for further assistance.\n\n#### Example:\n```\nWould you like to send issue? [y/N]: y\n```\n\nContributing\n------------\n\nContributions to the Compressor CLI are welcome. Please refer to the project's CONTRIBUTING guide for more details on how to contribute.\n\nLicense\n-------\n\nThe Compressor CLI is licensed under the MIT License. See the LICENSE file for more details.",
"bugtrack_url": null,
"license": null,
"summary": null,
"version": "0.1.2",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9238408498cf3072389509fee3a31c8be2299274d19592ac0bf9b3e9bfdb5d7d",
"md5": "052cc5f5136d2e09de2e7e2d09db15ef",
"sha256": "60d0f58feeb79a64e9c8cc8152d653c1bf3343086d0bc94bcd352b58d54978d9"
},
"downloads": -1,
"filename": "compresslib-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "052cc5f5136d2e09de2e7e2d09db15ef",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 10553,
"upload_time": "2024-06-27T13:18:41",
"upload_time_iso_8601": "2024-06-27T13:18:41.903532Z",
"url": "https://files.pythonhosted.org/packages/92/38/408498cf3072389509fee3a31c8be2299274d19592ac0bf9b3e9bfdb5d7d/compresslib-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c8561852743cce97998e07d2f0f1d6a90f0e48fbbdb19a5d9a0b0d97b26e6c00",
"md5": "d7e01a440c288aa11ae270a750c59c26",
"sha256": "86a9289033d7850f9105f313f44ee7d0a29c970cae30e7ed8536c57214d27ffe"
},
"downloads": -1,
"filename": "compresslib-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "d7e01a440c288aa11ae270a750c59c26",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 17258,
"upload_time": "2024-06-27T13:18:43",
"upload_time_iso_8601": "2024-06-27T13:18:43.804153Z",
"url": "https://files.pythonhosted.org/packages/c8/56/1852743cce97998e07d2f0f1d6a90f0e48fbbdb19a5d9a0b0d97b26e6c00/compresslib-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-27 13:18:43",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "compresslib"
}
