PyClipdrop

Copyright © 2024 Minura Punchihewa

PyClipdrop is a Python library for interacting with the Clipdrop API. Clipdrop is a service that allows you to perform a variety of tasks on images such removing the background, removing text, and more.

Installation

With pip

pip install pyclipdrop

Usage

The library will first need to be configured with a Clipdrop API key. You can get an API key by signing up for the Clipdrop API. Once you have an API key, you can either set it to the CLIPDROP_API_KEY environment variable or pass it to the constructor of the ClipdropClient class.

from pyclipdrop import ClipdropClient

client = ClipdropClient('your-api-key')
# OR, if you have the API key set as an environment variable
client = ClipdropClient()

This client can now be used to perform a variety of tasks.

Cleanup

client.cleanup(
    image_file='path/to/input.png',
    mask_file='path/to/mask.png',
    output_file='path/to/output.png'
)

Image Upscaling

client.image_upscaling(
    image_file='path/to/input.png',
    target_width=1920,
    target_height=1080,
    output_file='path/to/output.png'
)

Portrait Depth Estimation

client.portrait_depth_estimation(
    image_file='path/to/input.png',
    output_file='path/to/output.jpg'
)

Portrait Surface Normals

client.portrait_surface_normals(
    image_file='path/to/input.png',
    output_file='path/to/output.jpg'
)

Reimagine

client.reimagine(
    image_file='path/to/input.png',
    output_file='path/to/output.jpg'
)

Remove Background

client.remove_background(
    image_file='path/to/input.png',
    output_file='path/to/output.png'
)

Remove Text

client.remove_text(
    image_file='path/to/input.png',
    output_file='path/to/output.png'
)

Replace Background

client.replace_background(
    image_file='path/to/input.png',
    prompt='a cozy marble kitchen with wine glasses',
    output_file='path/to/output.png'
)

Sketch to Image

client.sketch_to_image(
    image_file='path/to/input.png',
    prompt='an owl on a branch, cinematic',
    output_file='path/to/output.jpg'
)

Text Inpainting

client.text_inpainting(
    image_file='path/to/input.png',
    mask_file='path/to/mask.png',
    prompt='A woman with a red scarf',
    output_file='path/to/output.jpg'
)

Text to Image

client.text_to_image(
    prompt='shot of vaporwave fashion dog in miami',
    output_file='path/to/output.png'
)

Uncrop

client.uncrop(
    image_file='path/to/input.png',
    extend_left=120,
    extend_right=-50,
    output_file='path/to/output.jpg'
)

License

This code is licensed under the GNU GENERAL PUBLIC LICENSE. See LICENSE.txt for details.