# PyConvertAPI Image Converter
PyConvertAPI Image Converter is a Python library for converting images to different formats using [ConvertAPI](https://www.convertapi.com/). ConvertAPI is a cloud based file conversion API. It allows you to convert files from one format to another. It supports over 200 different file formats and conversion types. ConvertAPI is a paid service. You can sign up for a free account and get 100 free conversions per month. You can also get a paid account with more conversions per month. You can find more information about ConvertAPI at [convertapi.com](https://www.convertapi.com/).
## Installation
* Ensure you have python3 and pip installed on your system.
* You can the install PyConvertAPI Image Converter using pip:
```bash
pip install pyconvertapi-image-converter
```
## Usage
### Importing the library
To use the library, you need to import it into your project. You can import the library using the following code:
```python
import pyconvertapi_image_converter
```
### Creating a ConvertAPIImageConverter object
To create a ConvertAPIImageConverter object as well to as convert an image, you need to provide your ConvertAPI secret. You can get your ConvertAPI secret from your ConvertAPI account. You can create a ConvertAPIImageConverter object using the following code:
```python
from pyconvertapi_image_converter import ConvertAPIImageConverter
# Create a ConvertAPIImageConverter object
converter = ConvertAPIImageConverter('your_secret')
# Convert an image to PNG format
converter.convert(path='path/to/image.jpg', to_format='png')
# Convert an image to SVG format
converter.convert(path='path/to/image.jpeg', to_format='svg')
```
### Converting all images in a directory
To convert all images in a directory, you can use the following code:
```python
from pyconvertapi_image_converter import ConvertAPIImageConverter
converter = ConvertAPIImageConverter('your_secret')
# Convert all images in a directory to PNG format
converter.convert('path/to/directory', to_format='png')
```
### Supported formats
To get a list of supported formats, you can use the following code:
```python
from pyconvertapi_image_converter.image_converter import to_formats, from_formats
# Get a list of supported formats for input files
print(from_formats)
# Get a list of supported formats for output files
print(to_formats)
```
## License
PyConvertAPI Image Converter is licensed under the
[MIT](https://choosealicense.com/licenses/mit/)
## Contributing
Pull requests and feedbacks are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## Authors and acknowledgment
* [**ti-oluwa**](https://github.com/ti-oluwa) 
* [**ConvertAPI**](https://www.convertapi.com/)
* [**ConvertAPI Python Client**](https://github.com/ConvertAPI/convertapi-python)
Raw data
{
"_id": null,
"home_page": "",
"name": "pyconvertapi-image-converter",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "ti-oluwa <tioluwa.dev@gmail.com>",
"keywords": "Image format conversion,ConvertAPI",
"author": "",
"author_email": "ti-oluwa <tioluwa.dev@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/5d/24/407dca7b817840ac391a153d7d63fa4e17f91b0a4c780c55fe120bf98fd2/pyconvertapi_image_converter-0.1.3.tar.gz",
"platform": null,
"description": "# PyConvertAPI Image Converter\r\n\r\n\r\n\r\n\r\n\r\n\r\nPyConvertAPI Image Converter is a Python library for converting images to different formats using [ConvertAPI](https://www.convertapi.com/). ConvertAPI is a cloud based file conversion API. It allows you to convert files from one format to another. It supports over 200 different file formats and conversion types. ConvertAPI is a paid service. You can sign up for a free account and get 100 free conversions per month. You can also get a paid account with more conversions per month. You can find more information about ConvertAPI at [convertapi.com](https://www.convertapi.com/).\r\n\r\n## Installation\r\n\r\n* Ensure you have python3 and pip installed on your system.\r\n* You can the install PyConvertAPI Image Converter using pip:\r\n\r\n```bash\r\npip install pyconvertapi-image-converter\r\n```\r\n\r\n## Usage\r\n\r\n### Importing the library\r\n\r\nTo use the library, you need to import it into your project. You can import the library using the following code:\r\n\r\n```python\r\nimport pyconvertapi_image_converter\r\n```\r\n\r\n### Creating a ConvertAPIImageConverter object\r\n\r\nTo create a ConvertAPIImageConverter object as well to as convert an image, you need to provide your ConvertAPI secret. You can get your ConvertAPI secret from your ConvertAPI account. You can create a ConvertAPIImageConverter object using the following code:\r\n\r\n```python\r\nfrom pyconvertapi_image_converter import ConvertAPIImageConverter\r\n\r\n# Create a ConvertAPIImageConverter object\r\nconverter = ConvertAPIImageConverter('your_secret')\r\n\r\n# Convert an image to PNG format\r\nconverter.convert(path='path/to/image.jpg', to_format='png')\r\n\r\n# Convert an image to SVG format\r\nconverter.convert(path='path/to/image.jpeg', to_format='svg')\r\n```\r\n\r\n### Converting all images in a directory\r\n\r\nTo convert all images in a directory, you can use the following code:\r\n\r\n```python\r\nfrom pyconvertapi_image_converter import ConvertAPIImageConverter\r\n\r\nconverter = ConvertAPIImageConverter('your_secret')\r\n\r\n# Convert all images in a directory to PNG format\r\nconverter.convert('path/to/directory', to_format='png')\r\n```\r\n\r\n\r\n### Supported formats\r\n\r\nTo get a list of supported formats, you can use the following code:\r\n\r\n```python\r\nfrom pyconvertapi_image_converter.image_converter import to_formats, from_formats\r\n\r\n# Get a list of supported formats for input files\r\nprint(from_formats)\r\n\r\n# Get a list of supported formats for output files\r\nprint(to_formats)\r\n```\r\n\r\n## License\r\n\r\nPyConvertAPI Image Converter is licensed under the\r\n[MIT](https://choosealicense.com/licenses/mit/)\r\n\r\n## Contributing\r\n\r\nPull requests and feedbacks are welcome. For major changes, please open an issue first to discuss what you would like to change.\r\n\r\nPlease make sure to update tests as appropriate.\r\n\r\n## Authors and acknowledgment\r\n\r\n* [**ti-oluwa**](https://github.com/ti-oluwa) \r\n* [**ConvertAPI**](https://www.convertapi.com/)\r\n* [**ConvertAPI Python Client**](https://github.com/ConvertAPI/convertapi-python)\r\n",
"bugtrack_url": null,
"license": "",
"summary": "PyConvertAPI Image Converter is a Python library for converting images to different formats using ConvertAPI",
"version": "0.1.3",
"project_urls": {
"Bug Tracker": "https://github.com/ti-oluwa/pyconvertapi_image_converter/issues",
"Homepage": "https://github.com/ti-oluwa/pyconvertapi_image_converter",
"Repository": "https://github.com/ti-oluwa/pyconvertapi_image_converter"
},
"split_keywords": [
"image format conversion",
"convertapi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fdc82b0dc7c243327c3b0e393037fed54a34498e5e0885ccd1644c39057ee925",
"md5": "df17168bce27b261d71e475713684dd5",
"sha256": "ded9485be178ea57242fbe8c560f4043a34e16338fdbf2dc19f7d885a0baaa6e"
},
"downloads": -1,
"filename": "pyconvertapi_image_converter-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "df17168bce27b261d71e475713684dd5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 6119,
"upload_time": "2023-08-13T09:28:16",
"upload_time_iso_8601": "2023-08-13T09:28:16.061444Z",
"url": "https://files.pythonhosted.org/packages/fd/c8/2b0dc7c243327c3b0e393037fed54a34498e5e0885ccd1644c39057ee925/pyconvertapi_image_converter-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5d24407dca7b817840ac391a153d7d63fa4e17f91b0a4c780c55fe120bf98fd2",
"md5": "ea67c51ba185935d89a30f4aea577747",
"sha256": "1ab83b91757fb4aa0ff0ac3e6c0bcbefcc5f9fa9c2503645d7f3624fb624e815"
},
"downloads": -1,
"filename": "pyconvertapi_image_converter-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "ea67c51ba185935d89a30f4aea577747",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 5411,
"upload_time": "2023-08-13T09:28:19",
"upload_time_iso_8601": "2023-08-13T09:28:19.430781Z",
"url": "https://files.pythonhosted.org/packages/5d/24/407dca7b817840ac391a153d7d63fa4e17f91b0a4c780c55fe120bf98fd2/pyconvertapi_image_converter-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-13 09:28:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ti-oluwa",
"github_project": "pyconvertapi_image_converter",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "convertapi",
"specs": []
}
],
"lcname": "pyconvertapi-image-converter"
}
JSON
