<!-- markdownlint-disable MD033 MD036 MD041 MD045 MD046 -->
<div align="center">
<img width="200" src="https://i.imgur.com/HeeZxH3.png" alt="Coco Logo">
</div>
<div align="center">
<h1 style="border-bottom: none">
<b><a href="#">CLI Video Compressor</a></b>
</h1>
***`Pack`*** is a simple yet powerful CLI video compressor.
It reduces file sizes by up to 60% while maintaining high quality, using `FFmpeg` under the hood. Compress individual videos or entire folders with ease.
[](https://opensource.org/licenses/MIT)
<a href="https://discord.gg/tDvybtJ7y9">
<img alt="Discord Server" height="50" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/social/discord-plural_vector.svg">
</a>
<p align="center">
<a href="https://github.com/ivansaul/CLI-Video-Compressor/blob/master/README.md">English</a>
｜
<a href="https://github.com/ivansaul/CLI-Video-Compressor/blob/master/README.es.md">Español</a>
</p>
</div>
---
![demo][demo]
## Installation | Upgrade
You might be sure that you have installed [*`Python 3.10+`*][python] and [*`FFmpeg`*][ffmpeg]. The CLI app uses `FFmpeg` under the hood, so make sure you have it installed and added to your PATH.
```console
pip install -U vidpack
```
<details>
<summary>Prerequisites</summary>
```console
# MacOS
brew install ffmpeg
# Ubuntu
sudo apt install ffmpeg
# ArchLinux
sudo pacman -S ffmpeg
# Fedora
sudo dnf install ffmpeg
```
</details>
## Basic Usage
To compress a video or multiple videos, you will use the `pack` command, followed by the required input argument (a file or a directory).
```console
pack INPUT [OPTIONS]
```
> [!NOTE]
> `INPUT`: This is the file or directory you want to process. If you provide a directory, all videos within it will be compressed.
<!-- -->
> [!TIP]
> For additional help or to see all available options, you can use the command:
>
> ```console
> pack --help
> ```
## Options
Pack offers several options to customize the compression process:
- `--output`, `-o`: Specifies the output file to save the compressed video.
- `--quality`, `-q`: Defines the video quality level (0-100). Default value: 75.
- `--overwrite`, `-w`: Overwrites the output file if it already exists.
- `--delete-original`, `-d`: Deletes the original video after successful compression.
- `--codec`, `-c`: Specifies the video codec to use for compression(`h264`, `libx265`). Default is `h264`.
- `--verbose`, `-v`: Enables debugging mode for more information during the process.
> [!IMPORTANT]
> The H265 (`libx265`) codec offers superior compression quality and produces smaller file sizes compared to `H264`. However, encoding with H265 is more time-consuming and requires significantly more processing power. If you have a modern GPU and enough time for encoding, H265 is an excellent choice for reducing file sizes without sacrificing quality.
## Usage Examples
To compress a video named `video.mp4`, simply run:
```console
pack video.mp4
```
This command will compress `video.mp4` with default settings(quality: 75) and save the result as `video_compressed.mp4` in the same directory.
<details>
<summary>Show more examples</summary>
### Specify an output file
If you want to specify the name or location of the compressed file:
```console
pack video.mp4 --output compressed/small_video.mp4
```
This command will compress `video.mp4` and save the result as `small_video.mp4` in the `compressed` directory.
### Adjust compression quality
To compress a video with a specific quality (e.g., 60):
``` console
pack video.mp4 -q 60
```
This will compress the video with lower quality, resulting in a smaller file size.
### Compress all videos in a directory
To compress all videos in a directory:
```console
pack /path/to/my/videos
```
This command will compress all videos in the specified directory and save the results in the same directory.
### Overwrite existing files
If you want to overwrite existing compressed files:
```console
pack video.mp4 --output output.mp4 --overwrite
```
This will overwrite the file `output.mp4` if it already exists.
### Delete the original file after compression
To delete the original video file after successful compression:
```console
pack video.mp4 --delete-original
```
The original `video.mp4` will be deleted after compression.
### Specify a video codec
To compress a video with a specific video codec (e.g., libx265):
```console
pack video.mp4 --codec libx265
```
This will compress the video with the libx265 codec, resulting in a smaller file size. Currently, only `h264` and `libx265` codecs are supported.
### Use multiple options
You can combine multiple options in a single command:
```console
pack video.mp4 -o compressed.mp4 -q 80 -w -d -v
```
This command will compress `video.mp4` with a quality of 80, save the result as `compressed.mp4`, overwrite if the file exists, delete the original, and display detailed information during the process.
</details>
## Additional Notes
- The quality option (`-q`) affects both visual quality and file size. A lower value will result in a smaller file but lower visual quality, while a higher value will maintain better quality but with a larger file size.
- It's always recommended to backup your original videos before using the delete option (`-d`).
- The verbose mode (`-v`) is useful for diagnosing issues or better understanding the compression process.
> [!TIP]
> If you are a Windows user, you can install `ffmpeg` and `python` manually or using package managers like [*`Scoop`*][scoop].
> Once you have installed a package manager, you can just run something like `scoop install python ffmpeg`.
<!-- -->
> [!TIP]
> Windows user can watch a tutorial video on YouTube about the installation process [[Here]][demo-windows].
## Contributors
<a href="https://github.com/ivansaul/CLI-Video-Compressor/graphs/contributors">
<img src="https://contrib.rocks/image?repo=ivansaul%2FCLI%2DVideo%2DCompressor"/>
</a>
## See my other projects
[](https://github.com/ivansaul/codigo_facilito_downloader)
[](https://github.com/ivansaul/personal-portfolio)
[](https://github.com/ivansaul/flutter_todo_app)
[python]:https://www.python.org/downloads/
[ffmpeg]:https://ffmpeg.org
[demo]:https://github.com/user-attachments/assets/9c9c672a-bfa3-418a-b7d1-89f0e7751146
[scoop]:https://scoop.sh
[demo-windows]: https://youtu.be/w1Pba7Bu0ZQ
Raw data
{
"_id": null,
"home_page": "https://github.com/ivansaul/CLI-Video-Compressor",
"name": "vidpack",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "video, compression, ffmpeg, python",
"author": "ivansaul",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/b3/b9/5ecdf2d148f5e3cf67dca3bc0ae95b7ae2747286919d9d1353401c2240df/vidpack-0.3.1.tar.gz",
"platform": null,
"description": "<!-- markdownlint-disable MD033 MD036 MD041 MD045 MD046 -->\n\n<div align=\"center\">\n <img width=\"200\" src=\"https://i.imgur.com/HeeZxH3.png\" alt=\"Coco Logo\">\n</div>\n<div align=\"center\">\n\n<h1 style=\"border-bottom: none\">\n <b><a href=\"#\">CLI Video Compressor</a></b>\n</h1>\n\n***`Pack`*** is a simple yet powerful CLI video compressor.\n\nIt reduces file sizes by up to 60% while maintaining high quality, using `FFmpeg` under the hood. Compress individual videos or entire folders with ease.\n\n\n\n\n[](https://opensource.org/licenses/MIT)\n\n<a href=\"https://discord.gg/tDvybtJ7y9\">\n <img alt=\"Discord Server\" height=\"50\" src=\"https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/social/discord-plural_vector.svg\">\n</a>\n\n<p align=\"center\">\n <a href=\"https://github.com/ivansaul/CLI-Video-Compressor/blob/master/README.md\">English</a>\n \uff5c\n <a href=\"https://github.com/ivansaul/CLI-Video-Compressor/blob/master/README.es.md\">Espa\u00f1ol</a>\n</p>\n\n</div>\n\n---\n\n![demo][demo]\n\n## Installation | Upgrade\n\nYou might be sure that you have installed [*`Python 3.10+`*][python] and [*`FFmpeg`*][ffmpeg]. The CLI app uses `FFmpeg` under the hood, so make sure you have it installed and added to your PATH.\n\n```console\npip install -U vidpack\n```\n\n<details>\n <summary>Prerequisites</summary>\n\n ```console\n # MacOS\n brew install ffmpeg\n\n # Ubuntu\n sudo apt install ffmpeg\n\n # ArchLinux\n sudo pacman -S ffmpeg\n\n # Fedora\n sudo dnf install ffmpeg\n ```\n\n</details>\n\n## Basic Usage\n\nTo compress a video or multiple videos, you will use the `pack` command, followed by the required input argument (a file or a directory).\n\n```console\npack INPUT [OPTIONS]\n```\n\n> [!NOTE]\n> `INPUT`: This is the file or directory you want to process. If you provide a directory, all videos within it will be compressed.\n\n<!-- -->\n> [!TIP]\n> For additional help or to see all available options, you can use the command:\n>\n> ```console\n> pack --help\n> ```\n\n## Options\n\nPack offers several options to customize the compression process:\n\n- `--output`, `-o`: Specifies the output file to save the compressed video.\n- `--quality`, `-q`: Defines the video quality level (0-100). Default value: 75.\n- `--overwrite`, `-w`: Overwrites the output file if it already exists.\n- `--delete-original`, `-d`: Deletes the original video after successful compression.\n- `--codec`, `-c`: Specifies the video codec to use for compression(`h264`, `libx265`). Default is `h264`.\n- `--verbose`, `-v`: Enables debugging mode for more information during the process.\n\n> [!IMPORTANT]\n> The H265 (`libx265`) codec offers superior compression quality and produces smaller file sizes compared to `H264`. However, encoding with H265 is more time-consuming and requires significantly more processing power. If you have a modern GPU and enough time for encoding, H265 is an excellent choice for reducing file sizes without sacrificing quality.\n\n## Usage Examples\n\nTo compress a video named `video.mp4`, simply run:\n\n```console\npack video.mp4\n```\n\nThis command will compress `video.mp4` with default settings(quality: 75) and save the result as `video_compressed.mp4` in the same directory.\n\n<details>\n <summary>Show more examples</summary>\n\n### Specify an output file\n\nIf you want to specify the name or location of the compressed file:\n\n```console\npack video.mp4 --output compressed/small_video.mp4\n```\n\nThis command will compress `video.mp4` and save the result as `small_video.mp4` in the `compressed` directory.\n\n### Adjust compression quality\n\nTo compress a video with a specific quality (e.g., 60):\n\n``` console\npack video.mp4 -q 60\n```\n\nThis will compress the video with lower quality, resulting in a smaller file size.\n\n### Compress all videos in a directory\n\nTo compress all videos in a directory:\n\n```console\npack /path/to/my/videos\n```\n\nThis command will compress all videos in the specified directory and save the results in the same directory.\n\n### Overwrite existing files\n\nIf you want to overwrite existing compressed files:\n\n```console\npack video.mp4 --output output.mp4 --overwrite\n```\n\nThis will overwrite the file `output.mp4` if it already exists.\n\n### Delete the original file after compression\n\nTo delete the original video file after successful compression:\n\n```console\npack video.mp4 --delete-original\n```\n\nThe original `video.mp4` will be deleted after compression.\n\n### Specify a video codec\n\nTo compress a video with a specific video codec (e.g., libx265):\n\n```console\npack video.mp4 --codec libx265\n```\n\nThis will compress the video with the libx265 codec, resulting in a smaller file size. Currently, only `h264` and `libx265` codecs are supported.\n\n### Use multiple options\n\nYou can combine multiple options in a single command:\n\n```console\npack video.mp4 -o compressed.mp4 -q 80 -w -d -v\n```\n\nThis command will compress `video.mp4` with a quality of 80, save the result as `compressed.mp4`, overwrite if the file exists, delete the original, and display detailed information during the process.\n\n</details>\n\n## Additional Notes\n\n- The quality option (`-q`) affects both visual quality and file size. A lower value will result in a smaller file but lower visual quality, while a higher value will maintain better quality but with a larger file size.\n- It's always recommended to backup your original videos before using the delete option (`-d`).\n- The verbose mode (`-v`) is useful for diagnosing issues or better understanding the compression process.\n\n> [!TIP]\n> If you are a Windows user, you can install `ffmpeg` and `python` manually or using package managers like [*`Scoop`*][scoop].\n> Once you have installed a package manager, you can just run something like `scoop install python ffmpeg`.\n\n<!-- -->\n> [!TIP]\n> Windows user can watch a tutorial video on YouTube about the installation process [[Here]][demo-windows].\n\n## Contributors\n\n<a href=\"https://github.com/ivansaul/CLI-Video-Compressor/graphs/contributors\">\n <img src=\"https://contrib.rocks/image?repo=ivansaul%2FCLI%2DVideo%2DCompressor\"/>\n</a>\n\n## See my other projects\n\n[](https://github.com/ivansaul/codigo_facilito_downloader)\n[](https://github.com/ivansaul/personal-portfolio)\n[](https://github.com/ivansaul/flutter_todo_app)\n\n[python]:https://www.python.org/downloads/\n[ffmpeg]:https://ffmpeg.org\n[demo]:https://github.com/user-attachments/assets/9c9c672a-bfa3-418a-b7d1-89f0e7751146\n[scoop]:https://scoop.sh\n[demo-windows]: https://youtu.be/w1Pba7Bu0ZQ\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python script for efficiently compressing videos without sacrificing quality",
"version": "0.3.1",
"project_urls": {
"Homepage": "https://github.com/ivansaul/CLI-Video-Compressor",
"Repository": "https://github.com/ivansaul/CLI-Video-Compressor"
},
"split_keywords": [
"video",
" compression",
" ffmpeg",
" python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a6ff0f889d1619454110baf3c8600c0bf0d7dfa006f331888487816bc46bb12b",
"md5": "dbb1f677ab139543fc857852d5ba2b3a",
"sha256": "6165059414eb1f6211d2548a95907e134ef03e5d909a3cbf51960322bdfd5e2d"
},
"downloads": -1,
"filename": "vidpack-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dbb1f677ab139543fc857852d5ba2b3a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 11615,
"upload_time": "2024-10-10T08:33:18",
"upload_time_iso_8601": "2024-10-10T08:33:18.840509Z",
"url": "https://files.pythonhosted.org/packages/a6/ff/0f889d1619454110baf3c8600c0bf0d7dfa006f331888487816bc46bb12b/vidpack-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b3b95ecdf2d148f5e3cf67dca3bc0ae95b7ae2747286919d9d1353401c2240df",
"md5": "527b9cf4d5c640316d2364863eaf97a6",
"sha256": "0e34f5049f36492b031820834938d2c7783b95a735d5c10438722909cd2a8612"
},
"downloads": -1,
"filename": "vidpack-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "527b9cf4d5c640316d2364863eaf97a6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 11215,
"upload_time": "2024-10-10T08:33:20",
"upload_time_iso_8601": "2024-10-10T08:33:20.338474Z",
"url": "https://files.pythonhosted.org/packages/b3/b9/5ecdf2d148f5e3cf67dca3bc0ae95b7ae2747286919d9d1353401c2240df/vidpack-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-10 08:33:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ivansaul",
"github_project": "CLI-Video-Compressor",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "vidpack"
}
JSON
