Skip to main content

A Python Package to Generate Images with http://pixlr.com programmatically.

Project description

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:

    from pixlr_private_api.main import PixlrApi
    
  2. Initialize PixlrApi Object:

    pixlr = PixlrApi()
    
  3. Registration:

    registered = pixlr.register()
    if registered:
        print("Successfully registered!")
    
  4. Email Verification:

    verified = pixlr.verify_email()
    if verified:
        print("Email verified successfully!")
    
  5. Generate Image:

    # 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):

    deleted = pixlr.delete_account()
    if deleted:
        print("Account deleted successfully!")
    
  7. Remove An Image Background

image_path = "/tmp/1e62c8856e064e04b1cf3d71739a1d2b.png" # The image of your coice
pixlr.remove_bg(image_path) # Returns a new image Path with the background Removed!

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pixlr_private_api-0.0.3.tar.gz (5.4 kB view details)

Uploaded Source

File details

Details for the file pixlr_private_api-0.0.3.tar.gz.

File metadata

  • Download URL: pixlr_private_api-0.0.3.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.0

File hashes

Hashes for pixlr_private_api-0.0.3.tar.gz
Algorithm Hash digest
SHA256 34e1e69a09bb985fc4d50f1a584c6249e55cd14131f0b5432efbe9a613eddc79
MD5 dfc31fa6be90d152b8a7f3620a25dde7
BLAKE2b-256 8a0506df9c36d6be5055fdb10a4360956251bd180631e36215fe28114eb011a4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page