# ImgGenCli 💠
`imggencli` is a community-maintained cli designed to provide users with the ability to generate, edit and filter images using the DALL-E 2 API provided by OpenAI, all from the command line.
The tool provides three main commands, generate, edit, and filter.
The `generate` command allows the user to generate an image using a prompt, with the option to apply a filter, specify the size, and choose the number of times to generate the image. The generated image can also be saved to a specified file path.
The `edit` command provides the ability to edit an existing image by adjusting the brightness, contrast, and sharpness of the image. The edited image is then saved to a new file.
The `filter` command allows users to apply various filters and effects to an existing image. The user can select from a range of different filters, and the filtered image can be saved to a specified file path.
Thus it allows for a low end build that can work on almost all computers with high sense of flexibility with it's customization options.
## Configuration
The cli requires you to have an api token to query the OpenAI's api. You can read about and get it here https://platform.openai.com/account/api-keys.
## Installation
Install the imggencli python package directly from pypi.
```console
pip install imggencli
```
## Usage
```console
Usage: imggencli [OPTIONS] COMMAND [ARGS]...
💠 Use the Dall.E 2 api to generate, edit & filter images from the cmd line.
Options:
--help Show this message and exit.
Commands:
edit 🎴 Change the brightness, contrast and sharpness of an image.
filter 🦄 Apply filters and effects to an image.
generate 🌸 Generate an image from the OpenAI Dalle api.
update 🔐 Update the OpenAI API key.
```
### Commands and Options
**```generate```**
```console
Usage: imggencli generate [OPTIONS]
🌸 Generate an image from the OpenAI Dalle api
Options:
--prompt TEXT 💬 The prompt to generate the image from.
--size TEXT 📐 The size of the generated image.
--filter 🎨 Apply a filter to the generated image.
--iterations INTEGER 🔄 The number of times to generate the image
--save-path FILE 💾 Save the generated image to the specifiedfile path
--help Show this message and exit.
```
**```edit```**
```console
Usage: imggencli edit [OPTIONS] IMAGE_PATH
🎴 Change the brightness, contrast and sharpness of an image.
Options:
--brightness FLOAT 💡 The brightness of the image
--contrast FLOAT 🌈 The contrast of the image
--sharpness FLOAT 🔪 The sharpness of the image
--help Show this message and exit.
```
**```filter```**
```console
Usage: imggencli filter [OPTIONS] IMAGE_PATH
🦄 Apply filters and effects to an image.
Options:
--filter [grayscale|sepia|blur|contour|detail|edge_enhance|edge_enhance_more|emboss|find_edges|sharpen|smooth|smooth_more|outline|posterize|solarize|invert|flip]
🎨 The filter to apply to the image
--save-path PATH The directory to save the filtered image.
Defaults to the current directory.
--help Show this message and exit.
```
**```update```**
```console
Usage: imggencli update [OPTIONS]
🔐 Update the OpenAI API key.
Options:
--help Show this message and exit.
```
Please feel to create issues or request for features. There will be many features added to the cli.
Raw data
{
"_id": null,
"home_page": "https://github.com/shayan-shaikh/Image-generation-CLI",
"name": "imggencli",
"maintainer": "",
"docs_url": null,
"requires_python": ">3.5",
"maintainer_email": "",
"keywords": "cli,developer tools,productivity,openai,generative art,ai",
"author": "Shayan Shaikh",
"author_email": "Shaikhshayan1@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/5a/21/57ae4252902047becc15dfc50e320cfa2fde2463265b5db8a2167650be91/imggencli-1.4.4.tar.gz",
"platform": null,
"description": "# ImgGenCli \ud83d\udca0\r\n\r\n`imggencli` is a community-maintained cli designed to provide users with the ability to generate, edit and filter images using the DALL-E 2 API provided by OpenAI, all from the command line.\r\n\r\nThe tool provides three main commands, generate, edit, and filter.\r\n\r\nThe `generate` command allows the user to generate an image using a prompt, with the option to apply a filter, specify the size, and choose the number of times to generate the image. The generated image can also be saved to a specified file path.\r\n\r\nThe `edit` command provides the ability to edit an existing image by adjusting the brightness, contrast, and sharpness of the image. The edited image is then saved to a new file.\r\n\r\nThe `filter` command allows users to apply various filters and effects to an existing image. The user can select from a range of different filters, and the filtered image can be saved to a specified file path.\r\n\r\nThus it allows for a low end build that can work on almost all computers with high sense of flexibility with it's customization options.\r\n\r\n## Configuration\r\n\r\nThe cli requires you to have an api token to query the OpenAI's api. You can read about and get it here https://platform.openai.com/account/api-keys.\r\n\r\n## Installation\r\n\r\nInstall the imggencli python package directly from pypi. \r\n\r\n```console\r\n pip install imggencli\r\n```\r\n\r\n## Usage\r\n\r\n```console\r\nUsage: imggencli [OPTIONS] COMMAND [ARGS]...\r\n\r\n \ud83d\udca0 Use the Dall.E 2 api to generate, edit & filter images from the cmd line.\r\n\r\nOptions:\r\n --help Show this message and exit.\r\n\r\nCommands:\r\n edit \ud83c\udfb4 Change the brightness, contrast and sharpness of an image.\r\n filter \ud83e\udd84 Apply filters and effects to an image.\r\n generate \ud83c\udf38 Generate an image from the OpenAI Dalle api.\r\n update \ud83d\udd10 Update the OpenAI API key.\r\n```\r\n\r\n### Commands and Options\r\n\r\n**```generate```**\r\n```console\r\nUsage: imggencli generate [OPTIONS]\r\n\r\n \ud83c\udf38 Generate an image from the OpenAI Dalle api\r\n\r\nOptions:\r\n --prompt TEXT \ud83d\udcac The prompt to generate the image from.\r\n --size TEXT \ud83d\udcd0 The size of the generated image.\r\n --filter \ud83c\udfa8 Apply a filter to the generated image.\r\n --iterations INTEGER \ud83d\udd04 The number of times to generate the image\r\n --save-path FILE \ud83d\udcbe Save the generated image to the specifiedfile path\r\n --help Show this message and exit.\r\n```\r\n\r\n**```edit```**\r\n```console\r\nUsage: imggencli edit [OPTIONS] IMAGE_PATH\r\n\r\n \ud83c\udfb4 Change the brightness, contrast and sharpness of an image.\r\n\r\nOptions:\r\n --brightness FLOAT \ud83d\udca1 The brightness of the image\r\n --contrast FLOAT \ud83c\udf08 The contrast of the image\r\n --sharpness FLOAT \ud83d\udd2a The sharpness of the image\r\n --help Show this message and exit.\r\n```\r\n\r\n**```filter```**\r\n```console\r\nUsage: imggencli filter [OPTIONS] IMAGE_PATH\r\n\r\n \ud83e\udd84 Apply filters and effects to an image.\r\n\r\nOptions:\r\n --filter [grayscale|sepia|blur|contour|detail|edge_enhance|edge_enhance_more|emboss|find_edges|sharpen|smooth|smooth_more|outline|posterize|solarize|invert|flip]\r\n \ud83c\udfa8 The filter to apply to the image\r\n --save-path PATH The directory to save the filtered image.\r\n Defaults to the current directory.\r\n --help Show this message and exit.\r\n```\r\n\r\n**```update```**\r\n```console\r\nUsage: imggencli update [OPTIONS]\r\n\r\n \ud83d\udd10 Update the OpenAI API key.\r\n\r\nOptions:\r\n --help Show this message and exit.\r\n```\r\n\r\nPlease feel to create issues or request for features. There will be many features added to the cli.\r\n",
"bugtrack_url": null,
"license": "Open Source",
"summary": "A command line application to generate customized images based on the Open AI API.",
"version": "1.4.4",
"split_keywords": [
"cli",
"developer tools",
"productivity",
"openai",
"generative art",
"ai"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ce867a2dbb5859be93efc066616160e9f7624fdde1bcdc8f53d2aaafe560ed76",
"md5": "7f6a7735095d831859bc9fdf3b20c31d",
"sha256": "61ab96ac907f2fde95eaa011d4833843e30dfacc2df69c68df9cb403f67a3ca6"
},
"downloads": -1,
"filename": "imggencli-1.4.4-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "7f6a7735095d831859bc9fdf3b20c31d",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">3.5",
"size": 6551,
"upload_time": "2023-04-17T11:33:38",
"upload_time_iso_8601": "2023-04-17T11:33:38.015736Z",
"url": "https://files.pythonhosted.org/packages/ce/86/7a2dbb5859be93efc066616160e9f7624fdde1bcdc8f53d2aaafe560ed76/imggencli-1.4.4-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5a2157ae4252902047becc15dfc50e320cfa2fde2463265b5db8a2167650be91",
"md5": "bcd8610d47ca517281130010b11c3015",
"sha256": "843314e1d70b4080451bed55b2d4f4f4a7d1ac8282f50c33403e33f303038784"
},
"downloads": -1,
"filename": "imggencli-1.4.4.tar.gz",
"has_sig": false,
"md5_digest": "bcd8610d47ca517281130010b11c3015",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">3.5",
"size": 5982,
"upload_time": "2023-04-17T11:33:40",
"upload_time_iso_8601": "2023-04-17T11:33:40.880063Z",
"url": "https://files.pythonhosted.org/packages/5a/21/57ae4252902047becc15dfc50e320cfa2fde2463265b5db8a2167650be91/imggencli-1.4.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-17 11:33:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "shayan-shaikh",
"github_project": "Image-generation-CLI",
"lcname": "imggencli"
}
JSON
