### Pixlr API Usage Guide
This Python module provides a simple interface for automating actions on the Pixlr platform, including registration, email verification, generating images, and deleting accounts. Below is a guide on how to use this module effectively:
#### Prerequisites:
- Python 3.x installed on your system.
- Necessary Python libraries installed, including `requests`.
#### Usage Steps:
1. **Import the Module:**
```python
from pixlr_private_api.main import PixlrApi
```
2. **Initialize PixlrApi Object:**
```python
pixlr = PixlrApi()
```
3. **Registration:**
```python
registered = pixlr.register()
if registered:
print("Successfully registered!")
```
4. **Email Verification:**
```python
verified = pixlr.verify_email()
if verified:
print("Email verified successfully!")
```
5. **Generate Image:**
```python
# Provide width, height, amount, and prompt for image generation
images = pixlr.generate_image(width, height, amount, prompt)
# 'images' will contain paths to the generated images
```
6. **Delete Account (Optional):**
```python
deleted = pixlr.delete_account()
if deleted:
print("Account deleted successfully!")
```
7. **Remove An Image Background**
```python
image_path = "/tmp/1e62c8856e064e04b1cf3d71739a1d2b.png" # The image of your coice
pixlr.remove_bg(image_path) # Returns a new image Path with the background Removed!
```
8. **Auto Fix - Automatically does fixing**
```python
image_path = "/tmp/1e62c8856e064e04b1cf3d71739a1d2b.png" # The image of your coice
pixlr.auto_fix(image_path) # Returns a new image Path with auto fixes applied
```
9. **LowLight Enhance - Enhances the Quality of Image if in Low-Light**
```python
image_path = "/tmp/1e62c8856e064e04b1cf3d71739a1d2b.png" # The image of your coice
pixlr.lowlight_enhance(image_path) # Returns a new image Path with Enhanced Low Light
```
10. **Super Resolution - Scales the Image Up BY an integer Value**
```python
image_path = "/tmp/1e62c8856e064e04b1cf3d71739a1d2b.png" # The image of your coice
scale = 2
pixlr.super_resolution(image_path, scale=scale) # Returns a new image Path with Enhanced Low Light
```
11. **Style Transfer - Transfers the Style from one image to another!**
```python
image_path = "/tmp/1e62c8856e064e04b1cf3d71739a1d2b.png" # The image of your coice
image_style = "/tmp/some-style-image.png"
pixlr.super_resolution(image_path, image_style) # Returns a new image Path with Transfered Style!
```
12. **Image Caption Generating - Generating Captions/Descriptions From Images**
```python
image_path = "/tmp/1e62c8856e064e04b1cf3d71739a1d2b.png" # The image of your coice
pixlr.generate_image_caption(image_path) # Returns a string value of the caption!
```
13. **Image Tags Generating - Generating Tags/Keywords From Images**
```python
image_path = "/tmp/1e62c8856e064e04b1cf3d71739a1d2b.png" # The image of your coice
pixlr.generate_image_tags(image_path) # Returns a List of tags/keywords List[str]
```
### Additional Notes:
- Ensure to handle errors and exceptions appropriately for robust usage.
- This module interacts with Pixlr through web requests, so network connectivity is required.
- API requests may be rate-limited or subject to changes by Pixlr, so handle responses accordingly.
- Phosus, The Second API integrated in to this, thanks to Pixlr giving us free api keys, does leave a fingerprint in the temp folder (Mask Images for removing backgrounds, But no worries, your Operating System does delete them on restart).
This guide provides a basic overview of how to use the Pixlr API module. For detailed information on method parameters and return values, refer to the module's source code or documentation.
Raw data
{
"_id": null,
"home_page": "https://github.com/Automa-Automations/pixlr-private-api",
"name": "pixlr-private-api",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "temp-email automation email",
"author": "Simon Ferns",
"author_email": "business@simonferns.com",
"download_url": "https://files.pythonhosted.org/packages/b9/a3/2cb8ed0eacb917df193a14e2fcba03f93eca153c5383d5ca571fbfce1678/pixlr_private_api-0.1.2.tar.gz",
"platform": null,
"description": "### Pixlr API Usage Guide\n\nThis Python module provides a simple interface for automating actions on the Pixlr platform, including registration, email verification, generating images, and deleting accounts. Below is a guide on how to use this module effectively:\n\n#### Prerequisites:\n\n- Python 3.x installed on your system.\n- Necessary Python libraries installed, including `requests`.\n\n#### Usage Steps:\n\n1. **Import the Module:**\n\n ```python\n from pixlr_private_api.main import PixlrApi\n ```\n\n2. **Initialize PixlrApi Object:**\n\n ```python\n pixlr = PixlrApi()\n ```\n\n3. **Registration:**\n\n ```python\n registered = pixlr.register()\n if registered:\n print(\"Successfully registered!\")\n ```\n\n4. **Email Verification:**\n\n ```python\n verified = pixlr.verify_email()\n if verified:\n print(\"Email verified successfully!\")\n ```\n\n5. **Generate Image:**\n\n ```python\n # Provide width, height, amount, and prompt for image generation\n images = pixlr.generate_image(width, height, amount, prompt)\n # 'images' will contain paths to the generated images\n ```\n\n6. **Delete Account (Optional):**\n\n ```python\n deleted = pixlr.delete_account()\n if deleted:\n print(\"Account deleted successfully!\")\n ```\n\n7. **Remove An Image Background**\n\n ```python\n\n image_path = \"/tmp/1e62c8856e064e04b1cf3d71739a1d2b.png\" # The image of your coice\n pixlr.remove_bg(image_path) # Returns a new image Path with the background Removed!\n ```\n\n8. **Auto Fix - Automatically does fixing**\n\n ```python\n\n image_path = \"/tmp/1e62c8856e064e04b1cf3d71739a1d2b.png\" # The image of your coice\n pixlr.auto_fix(image_path) # Returns a new image Path with auto fixes applied\n ```\n\n9. **LowLight Enhance - Enhances the Quality of Image if in Low-Light**\n\n ```python\n\n image_path = \"/tmp/1e62c8856e064e04b1cf3d71739a1d2b.png\" # The image of your coice\n pixlr.lowlight_enhance(image_path) # Returns a new image Path with Enhanced Low Light\n ```\n\n10. **Super Resolution - Scales the Image Up BY an integer Value**\n\n ```python\n\n image_path = \"/tmp/1e62c8856e064e04b1cf3d71739a1d2b.png\" # The image of your coice\n scale = 2\n pixlr.super_resolution(image_path, scale=scale) # Returns a new image Path with Enhanced Low Light\n ```\n\n11. **Style Transfer - Transfers the Style from one image to another!**\n\n ```python\n\n image_path = \"/tmp/1e62c8856e064e04b1cf3d71739a1d2b.png\" # The image of your coice\n image_style = \"/tmp/some-style-image.png\"\n pixlr.super_resolution(image_path, image_style) # Returns a new image Path with Transfered Style!\n ```\n\n12. **Image Caption Generating - Generating Captions/Descriptions From Images**\n\n ```python\n\n image_path = \"/tmp/1e62c8856e064e04b1cf3d71739a1d2b.png\" # The image of your coice\n pixlr.generate_image_caption(image_path) # Returns a string value of the caption!\n ```\n\n13. **Image Tags Generating - Generating Tags/Keywords From Images**\n\n ```python\n\n image_path = \"/tmp/1e62c8856e064e04b1cf3d71739a1d2b.png\" # The image of your coice\n pixlr.generate_image_tags(image_path) # Returns a List of tags/keywords List[str]\n ```\n\n### Additional Notes:\n\n- Ensure to handle errors and exceptions appropriately for robust usage.\n- This module interacts with Pixlr through web requests, so network connectivity is required.\n- API requests may be rate-limited or subject to changes by Pixlr, so handle responses accordingly.\n- Phosus, The Second API integrated in to this, thanks to Pixlr giving us free api keys, does leave a fingerprint in the temp folder (Mask Images for removing backgrounds, But no worries, your Operating System does delete them on restart).\n\nThis guide provides a basic overview of how to use the Pixlr API module. For detailed information on method parameters and return values, refer to the module's source code or documentation.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python Package to Generate Images with http://pixlr.com programmatically.",
"version": "0.1.2",
"project_urls": {
"Homepage": "https://github.com/Automa-Automations/pixlr-private-api"
},
"split_keywords": [
"temp-email",
"automation",
"email"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b9a32cb8ed0eacb917df193a14e2fcba03f93eca153c5383d5ca571fbfce1678",
"md5": "fbe53c724d84bcc467575c37dba2a384",
"sha256": "3572190ae4472b714ff6eabc4bdff414f1415cb82f4728618838954e971507d9"
},
"downloads": -1,
"filename": "pixlr_private_api-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "fbe53c724d84bcc467575c37dba2a384",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6758,
"upload_time": "2024-04-04T03:26:55",
"upload_time_iso_8601": "2024-04-04T03:26:55.461462Z",
"url": "https://files.pythonhosted.org/packages/b9/a3/2cb8ed0eacb917df193a14e2fcba03f93eca153c5383d5ca571fbfce1678/pixlr_private_api-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-04 03:26:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Automa-Automations",
"github_project": "pixlr-private-api",
"github_not_found": true,
"lcname": "pixlr-private-api"
}
JSON
