# heif-convert
Multi-Platform command line tool written in Python to convert HEIF images.
## 📝 Table of Contents
- [About](#about)
- [Installation](#installation)
- [Usage](#usage)
- [Arguments](#arguments)
- [Libraries](#libraries)
- [Supported operating systems](#supported-operating-systems)
- [License](#license)
## 📕 About <a name="about"></a>
heif-convert is a multi-platform tool written in Python to convert High Efficiency Image File (HEIF) images to jpg, png, webp, gif, tiff, bmp, or ico.
heif-convert is designed to make HEIF batch conversion easy.
## ⚙️ Installation <a name="installation"></a>
## Python repository
The easiest way to get heif-convert is through the pypi.org repository. Install it by running the following command:
```bash
pip install heif-convert
```
## Building from source
To install heif-convert from source, clone this repository and run `pip install .` as follows:
```bash
git clone https://github.com/NeverMendel/heif-convert.git
cd heif-convert
pip install .
```
## Docker image
To pull heif-convert Docker image, run:
```bash
docker pull nevermendel/heif-convert
```
## Usage
heif-convert can be used from the command line by invoking the `heif-convert` command.
Convert an HEIF image to a JPG image:
```bash
heif-convert input.heic -f jpg
```
Convert all HEIF images in the current folder to JPG images:
```bash
heif-convert *.heic -f jpg
```
### Docker image
Convert an HEIF image to PNG using the Docker image:
```bash
docker run -v "$(pwd)":/usr/app/out --rm nevermendel/heif-convert input.heic -f jpg
```
## Arguments
```
usage: heif-convert [-h] [-o OUTPUT] [-p PATH]
[-f {jpg,png,webp,gif,tiff,bmp,ico}] [-q QUALITY] [-n] [-v]
[-vv] [-V]
input [input ...]
Command line tool to convert HEIF images
positional arguments:
input HEIF input file(s)
options:
-h, --help show this help message and exit
-o OUTPUT, --output OUTPUT
output file name
defaults to original file name (default: '{name}')
-p PATH, --path PATH output file path
defaults to original file path (default: '{path}')
-f {jpg,png,webp,gif,tiff,bmp,ico}, --format {jpg,png,webp,gif,tiff,bmp,ico}
output format (default: jpg)
-q QUALITY, --quality QUALITY
output quality, integer [0, 100] (default: 90)
-n, --no-exif Do not include EXIF metadata in the converted image
-v, --verbose enable verbose logging
-vv, --extra-verbose enable extra verbose logging
-V, --version show program's version number and exit
```
## Libraries
heif-convert uses the following libraries:
- [Pillow](https://github.com/python-pillow/Pillow)
- [pillow_heif](https://github.com/bigcat88/pillow_heif)
## Supported operating systems
heif-convert works on Linux, Mac OS and Windows systems. For further information refer to the [pillow_heif](https://github.com/bigcat88/pillow_heif) repository.
## License
[MIT License](LICENSE)
Raw data
{
"_id": null,
"home_page": "https://github.com/NeverMendel/heif-convert",
"name": "heif-convert",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "heif,heic,heif-convert,heic-convert",
"author": "Davide Cazzin",
"author_email": "28535750+NeverMendel@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/09/4e/e985ca9592614f9e9b74244f28df9e476cba2f6183e4682eff87ecf91acb/heif-convert-1.1.1.tar.gz",
"platform": null,
"description": "# heif-convert\n\nMulti-Platform command line tool written in Python to convert HEIF images.\n\n## \ud83d\udcdd Table of Contents\n\n- [About](#about)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Arguments](#arguments)\n- [Libraries](#libraries)\n- [Supported operating systems](#supported-operating-systems)\n- [License](#license)\n\n## \ud83d\udcd5 About <a name=\"about\"></a>\n\nheif-convert is a multi-platform tool written in Python to convert High Efficiency Image File (HEIF) images to jpg, png, webp, gif, tiff, bmp, or ico.\n\nheif-convert is designed to make HEIF batch conversion easy.\n\n## \u2699\ufe0f Installation <a name=\"installation\"></a>\n\n## Python repository\n\nThe easiest way to get heif-convert is through the pypi.org repository. Install it by running the following command:\n\n```bash\npip install heif-convert\n```\n\n## Building from source\n\nTo install heif-convert from source, clone this repository and run `pip install .` as follows:\n\n```bash\ngit clone https://github.com/NeverMendel/heif-convert.git\ncd heif-convert\npip install .\n```\n\n## Docker image\n\nTo pull heif-convert Docker image, run:\n\n```bash\ndocker pull nevermendel/heif-convert\n```\n\n## Usage\n\nheif-convert can be used from the command line by invoking the `heif-convert` command.\n\nConvert an HEIF image to a JPG image:\n\n```bash\nheif-convert input.heic -f jpg\n```\n\nConvert all HEIF images in the current folder to JPG images:\n\n```bash\nheif-convert *.heic -f jpg\n```\n\n### Docker image\n\nConvert an HEIF image to PNG using the Docker image:\n\n```bash\ndocker run -v \"$(pwd)\":/usr/app/out --rm nevermendel/heif-convert input.heic -f jpg\n```\n\n## Arguments\n\n```\nusage: heif-convert [-h] [-o OUTPUT] [-p PATH]\n [-f {jpg,png,webp,gif,tiff,bmp,ico}] [-q QUALITY] [-n] [-v]\n [-vv] [-V]\n input [input ...]\n\nCommand line tool to convert HEIF images\n\npositional arguments:\n input HEIF input file(s)\n\noptions:\n -h, --help show this help message and exit\n -o OUTPUT, --output OUTPUT\n output file name\n defaults to original file name (default: '{name}')\n -p PATH, --path PATH output file path\n defaults to original file path (default: '{path}')\n -f {jpg,png,webp,gif,tiff,bmp,ico}, --format {jpg,png,webp,gif,tiff,bmp,ico}\n output format (default: jpg)\n -q QUALITY, --quality QUALITY\n output quality, integer [0, 100] (default: 90)\n -n, --no-exif Do not include EXIF metadata in the converted image\n -v, --verbose enable verbose logging\n -vv, --extra-verbose enable extra verbose logging\n -V, --version show program's version number and exit\n```\n\n## Libraries\n\nheif-convert uses the following libraries:\n\n- [Pillow](https://github.com/python-pillow/Pillow)\n- [pillow_heif](https://github.com/bigcat88/pillow_heif)\n\n## Supported operating systems\n\nheif-convert works on Linux, Mac OS and Windows systems. For further information refer to the [pillow_heif](https://github.com/bigcat88/pillow_heif) repository.\n\n## License\n\n[MIT License](LICENSE)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Multi-Platform command line tool written in Python to convert HEIF images",
"version": "1.1.1",
"project_urls": {
"Homepage": "https://github.com/NeverMendel/heif-convert"
},
"split_keywords": [
"heif",
"heic",
"heif-convert",
"heic-convert"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "789e0642285e6eeee9588bf923e8cbd1b2d9b3bb9977a9de4a4f49aac11f011f",
"md5": "68aacaacf6acd42efb5b8e41ce52b309",
"sha256": "d0d650b2dac3e9f3059f87c6ba521e09ebea9804160fbc5a17ca3e824980159f"
},
"downloads": -1,
"filename": "heif_convert-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "68aacaacf6acd42efb5b8e41ce52b309",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 5253,
"upload_time": "2023-11-01T15:44:55",
"upload_time_iso_8601": "2023-11-01T15:44:55.598333Z",
"url": "https://files.pythonhosted.org/packages/78/9e/0642285e6eeee9588bf923e8cbd1b2d9b3bb9977a9de4a4f49aac11f011f/heif_convert-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "094ee985ca9592614f9e9b74244f28df9e476cba2f6183e4682eff87ecf91acb",
"md5": "da911e9f9620e932e9c5534da4396420",
"sha256": "8c3bed4c29d6567ffec008b7172c457b079df2f8e92947de5df5fe1465c03f37"
},
"downloads": -1,
"filename": "heif-convert-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "da911e9f9620e932e9c5534da4396420",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 4553,
"upload_time": "2023-11-01T15:44:56",
"upload_time_iso_8601": "2023-11-01T15:44:56.754004Z",
"url": "https://files.pythonhosted.org/packages/09/4e/e985ca9592614f9e9b74244f28df9e476cba2f6183e4682eff87ecf91acb/heif-convert-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-01 15:44:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NeverMendel",
"github_project": "heif-convert",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "heif-convert"
}
JSON
