# pixi-cli✨
pixi-cli is a command-line tool for image conversion and basic image processing tasks.
## Features
- Crop images
- Adjust exposure
- Adjust saturation
- Adjust contrast
- Adjust sharpness
- Apply box blur
- Apply Gaussian blur
- Reduce noise
- Detect edges
- Convert images to black and white
- Invert colors
- Rotate images (90, 180, 270 degrees)
- Flip images (horizontally and vertically)
- Create thumbnails
- Compress images
- Get image size
- Fetch image metadata
- Convert between image formats (e.g., jpg, png, bmp, gif, tiff, svg)
## Installation
You can either download Pixi-CLI through PyPI (recommended) or you can download the executable.
### Installing via PyPI
1. Ensure you have Python and pip installed on your machine.
2. Install pixi-cli using pip:
```sh
pip install pixi-cli
```
### Downloading the Executable
Download the executable from the latest release of `pixi` from the [Releases](https://github.com/zainkarim/pixi-cli/releases) page and run it directly.
## Usage
### Basic Usage
1. Open a terminal or Command Prompt.
2. Use the command line to perform various image processing tasks.
### Examples
1. **Get Image Size:**
```sh
pixi /path/to/input.jpg --size
```
2. **Get Image Metadata:**
```sh
pixi /path/to/input.jpg --metadata
```
3. **Crop Image:**
```sh
pixi /path/to/input.jpg --output_path /path/to/output.jpg --crop 50 50 200 200
```
4. **Adjust Exposure:**
```sh
pixi /path/to/input.jpg --output_path /path/to/output.jpg --exposure 1.2
```
5. **Apply Gaussian Blur:**
```sh
pixi /path/to/input.jpg --output_path /path/to/output.jpg --gaussian_blur 2.0
```
6. **Convert to Black and White:**
```sh
pixi /path/to/input.jpg --output_path /path/to/output.jpg --bw
```
7. **Rotate Image 90 Degrees:**
```sh
pixi /path/to/input.jpg --rotate90
```
8. **Convert Image Format:**
```sh
pixi /path/to/input.jpg --convert png
```
### Full Command-Line Arguments
- `image_path`: Path to the input image (required).
- `--output_path`: Path to save the processed image (required for processing operations).
- `--crop LEFT TOP RIGHT BOTTOM`: Crop the image to the specified box.
- `--exposure EV`: Adjust the exposure by a certain number of exposure values.
- `--saturation LEVEL`: Adjust saturation level.
- `--contrast LEVEL`: Adjust the contrast by the given factor.
- `--sharpness FACTOR`: Adjust the sharpness by the given factor.
- `--box_blur RADIUS`: Apply box blur with the specified radius.
- `--gaussian_blur RADIUS`: Apply Gaussian blur with the specified radius.
- `--reduce_noise`: Reduce noise in the image.
- `--edge_detect`: Detect edges in the image
- `--bw`: Convert the image to black and white.
- `--invert`: Invert the colors of the image.
- `--thumbnail width height`: Create a thumbnail of the specified size.
- `--compression QUALITY`: Compress the image to the specified quality (0-100).
- `--size`: Get the size of the image.
- `--metadata`: Fetch the metadata of the image.
- `--rotate90`: Rotate the image 90 degrees clockwise.
- `--rotate180`: Rotate the image 180 degrees.
- `--rotate270`: Rotate the image 270 degrees clockwise.
- `--flip_horiz`: Flip the image horizontally.
- `--flip_vert`: Flip the image vertically.
- `--convert FORMAT`: Convert the image to the specified format.
## Getting help
For more options and detailed usage, run:
```sh
pixi --help
```
## Contributing
Contributions are welcome! Please fork the repository and submit pull requests.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/zainkarim/pixi-cli",
"name": "pixi-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Zain Karim",
"author_email": "zain@zainkarim.com",
"download_url": "https://files.pythonhosted.org/packages/3a/0b/fd53837911fc1c253e3627b3ef0cee488867775f2feba4d79f070a550c00/pixi-cli-0.2.1.tar.gz",
"platform": null,
"description": "\n# pixi-cli\u2728\n\npixi-cli is a command-line tool for image conversion and basic image processing tasks.\n\n## Features\n\n- Crop images\n- Adjust exposure\n- Adjust saturation\n- Adjust contrast\n- Adjust sharpness\n- Apply box blur\n- Apply Gaussian blur\n- Reduce noise\n- Detect edges\n- Convert images to black and white\n- Invert colors\n- Rotate images (90, 180, 270 degrees)\n- Flip images (horizontally and vertically)\n- Create thumbnails\n- Compress images\n- Get image size\n- Fetch image metadata\n- Convert between image formats (e.g., jpg, png, bmp, gif, tiff, svg)\n\n## Installation\nYou can either download Pixi-CLI through PyPI (recommended) or you can download the executable.\n\n### Installing via PyPI\n\n1. Ensure you have Python and pip installed on your machine.\n2. Install pixi-cli using pip:\n```sh\npip install pixi-cli\n```\n\n### Downloading the Executable\n\nDownload the executable from the latest release of `pixi` from the [Releases](https://github.com/zainkarim/pixi-cli/releases) page and run it directly.\n\n## Usage\n\n### Basic Usage\n\n1. Open a terminal or Command Prompt.\n2. Use the command line to perform various image processing tasks.\n\n### Examples\n\n1. **Get Image Size:**\n ```sh\n pixi /path/to/input.jpg --size\n ```\n\n2. **Get Image Metadata:**\n ```sh\n pixi /path/to/input.jpg --metadata\n ```\n\n3. **Crop Image:**\n ```sh\n pixi /path/to/input.jpg --output_path /path/to/output.jpg --crop 50 50 200 200\n ```\n\n4. **Adjust Exposure:**\n ```sh\n pixi /path/to/input.jpg --output_path /path/to/output.jpg --exposure 1.2\n ```\n\n5. **Apply Gaussian Blur:**\n ```sh\n pixi /path/to/input.jpg --output_path /path/to/output.jpg --gaussian_blur 2.0\n ```\n\n6. **Convert to Black and White:**\n ```sh\n pixi /path/to/input.jpg --output_path /path/to/output.jpg --bw\n ```\n\n7. **Rotate Image 90 Degrees:**\n ```sh\n pixi /path/to/input.jpg --rotate90\n ```\n\n8. **Convert Image Format:**\n ```sh\n pixi /path/to/input.jpg --convert png\n ```\n\n### Full Command-Line Arguments\n\n- `image_path`: Path to the input image (required).\n- `--output_path`: Path to save the processed image (required for processing operations).\n- `--crop LEFT TOP RIGHT BOTTOM`: Crop the image to the specified box.\n- `--exposure EV`: Adjust the exposure by a certain number of exposure values.\n- `--saturation LEVEL`: Adjust saturation level.\n- `--contrast LEVEL`: Adjust the contrast by the given factor.\n- `--sharpness FACTOR`: Adjust the sharpness by the given factor.\n- `--box_blur RADIUS`: Apply box blur with the specified radius.\n- `--gaussian_blur RADIUS`: Apply Gaussian blur with the specified radius.\n- `--reduce_noise`: Reduce noise in the image.\n- `--edge_detect`: Detect edges in the image\n- `--bw`: Convert the image to black and white.\n- `--invert`: Invert the colors of the image.\n- `--thumbnail width height`: Create a thumbnail of the specified size.\n- `--compression QUALITY`: Compress the image to the specified quality (0-100).\n- `--size`: Get the size of the image.\n- `--metadata`: Fetch the metadata of the image.\n- `--rotate90`: Rotate the image 90 degrees clockwise.\n- `--rotate180`: Rotate the image 180 degrees.\n- `--rotate270`: Rotate the image 270 degrees clockwise.\n- `--flip_horiz`: Flip the image horizontally.\n- `--flip_vert`: Flip the image vertically.\n- `--convert FORMAT`: Convert the image to the specified format.\n\n## Getting help\nFor more options and detailed usage, run:\n```sh\npixi --help\n```\n\n## Contributing\n\nContributions are welcome! Please fork the repository and submit pull requests.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n",
"bugtrack_url": null,
"license": null,
"summary": "A command-line tool for basic image processing tasks.",
"version": "0.2.1",
"project_urls": {
"Homepage": "https://github.com/zainkarim/pixi-cli"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d08125a83c5580447ef9ddbb051b4d1fae0ec6a65b94428ee2df8d0b5923da2d",
"md5": "2902a85a374b38dac162a22ca32d7480",
"sha256": "9e5d28e81ad0eb11a26b2d2dde04cea58aad116f891b4628347d931bf92f9ef8"
},
"downloads": -1,
"filename": "pixi_cli-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2902a85a374b38dac162a22ca32d7480",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 6496,
"upload_time": "2024-08-01T21:31:43",
"upload_time_iso_8601": "2024-08-01T21:31:43.432382Z",
"url": "https://files.pythonhosted.org/packages/d0/81/25a83c5580447ef9ddbb051b4d1fae0ec6a65b94428ee2df8d0b5923da2d/pixi_cli-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3a0bfd53837911fc1c253e3627b3ef0cee488867775f2feba4d79f070a550c00",
"md5": "737e581181c4aa3baafd170f76ccbd31",
"sha256": "b29d4903176c136cae8caabb9e37f3347d67233a7bc49176bd6832f5fbcf935e"
},
"downloads": -1,
"filename": "pixi-cli-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "737e581181c4aa3baafd170f76ccbd31",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 5963,
"upload_time": "2024-08-01T21:31:44",
"upload_time_iso_8601": "2024-08-01T21:31:44.331611Z",
"url": "https://files.pythonhosted.org/packages/3a/0b/fd53837911fc1c253e3627b3ef0cee488867775f2feba4d79f070a550c00/pixi-cli-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-01 21:31:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zainkarim",
"github_project": "pixi-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "pixi-cli"
}
JSON
