https://github.com/lerubix/humanreadablecompressed
Python scripts for compressing and decompressing human-readable serialised files (YAML/JSON)
https://github.com/lerubix/humanreadablecompressed
compression json yaml
Last synced: 4 months ago
JSON representation
Python scripts for compressing and decompressing human-readable serialised files (YAML/JSON)
- Host: GitHub
- URL: https://github.com/lerubix/humanreadablecompressed
- Owner: LeRubix
- License: mpl-2.0
- Created: 2024-08-26T08:14:58.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-16T23:35:19.000Z (over 1 year ago)
- Last Synced: 2025-03-10T06:08:04.763Z (over 1 year ago)
- Topics: compression, json, yaml
- Language: Python
- Homepage:
- Size: 35.6 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# HumanReadableCompressed
Python scripts for compressing and decompressing human-readable serialized files (JSON/JSONL/YAML/YML). This project includes a convenient GUI executable file (`hrcGUI.exe`) for easy usage. Up to 99.8% compression has been achieved using this tool!
## Set up
To get started, download the [latest release](https://github.com/LeRubix/HumanReadableCompressed/releases/latest) and run the `hrcGUI.exe`, or execute the Python scripts through a terminal.
## Usage
### Command Line
To compress a file, use:
```bash
python hrc.py
```
To decompress a file, use:
```bash
python hrdc.py
```
### GUI
To use the GUI, simply open `hrcGUI.exe` and:
- Click the "Choose a file to compress" button to select a file for compression.
- Click the "Choose a file to decompress" button to select a `.hrc` file for decompression.
## Future Plans
I may release a version in the future that specifically supports adding this tool to your system's PATH. Additionally, I am considering developing a Visual Studio Code extension that can read `.hrc` files directly, eliminating the need for decompression.
## License
This project is licensed under the Mozilla Public License 2.0 (MPL-2.0). See the [LICENSE](LICENSE) file for more details.