Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dhhruv/compresssio
Streamline/Optimize your Images to save storage space...
https://github.com/dhhruv/compresssio
cli compression compressor framework hacktoberfest hacktoberfest2021 image image-compression image-compressor image-processing library png python shell terminal tinify tinypng
Last synced: 6 days ago
JSON representation
Streamline/Optimize your Images to save storage space...
- Host: GitHub
- URL: https://github.com/dhhruv/compresssio
- Owner: dhhruv
- License: mit
- Created: 2020-11-29T15:01:22.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T07:37:47.000Z (almost 2 years ago)
- Last Synced: 2023-05-14T17:15:48.823Z (over 1 year ago)
- Topics: cli, compression, compressor, framework, hacktoberfest, hacktoberfest2021, image, image-compression, image-compressor, image-processing, library, png, python, shell, terminal, tinify, tinypng
- Language: Python
- Homepage:
- Size: 21.5 KB
- Stars: 5
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Streamline/Optimize your Images to save storage space...
# Compresssio:
The above script uses TinyPNG's savvy lossy compression methods to reduce the document size of your JPG/PNG files. This is achieved by specifically decreasing the number of colors in the image, therefore lesser number of bytes are required to store the information. The impact of the script is nearly invisible but it makes an exceptionally enormous effect in file size of the image.
## Setup (Windows):
1. Install Python
2. Clone this repository
```
git clone https://github.com/dhhruv/Compresssio.git
```
3. Install, create and activate virtual environment.
For instance we create a virtual environment named 'venv'.
```
pip install virtualenv
python -m virtualenv venv
venv\Scripts\activate.bat
```
4. Install dependencies
```
pip install -r requirements.txt
```
## Initial Settings required:
1. Open `settings.py` in text editor of your choice.
2. Add the API_KEY key from [tinypng.com/developers](https://tinypng.com/developers/) to the `API_KEY` field.
3. In the `USER_INPUT_PATH` field add the path of the directory with original images (images to be compressed).
4. In the `USER_OUTPUT_PATH` field add the path of the directory with compressed files (where the compressed images will be saved).
## Easy way to use: (Windows)
Create `compression.bat` file with:
```
@echo off
cmd /c "path\to\venv\Scripts\python.exe path\to\Compresssio.py"
pause
```
Now run the Batch Script (.bat file) from any path you want.
## Important Note:
- **The limit you'll have at first is of 500 images per month on the Free plan. You can change this according to your requirement at [tinypng.com/dashboard/api](https://tinypng.com/dashboard/api)**
- **This Script is just a Prototype so Metadata is not stored in the Compressed Images from the Original Images.**
- **The Authors will not be responsible for any kind of loss of data so it is essential to have a Backup of Original Data placed in the Input Folder. Read the [LICENSE](https://github.com/dhhruv/Compresssio/blob/master/LICENSE) for more information.**