Skip to main content

Pika API python SDK.

Project description

Pika API Python SDK

View on pypi.org: pypi.org/project/pika-sdk

Installation

pip install pika-sdk

Usage

If you don't have your API key, get one from pika.style. Check the documentation on how to get your API key

Initialise

ps = pika_sdk.PikaSdk('YOUR_PIKA_API_KEY')

Generate image

response = ps.generate_image_from_template('open-graph-image-1', {'title': 'From python sdk new'}, 'base64')
print(response['data']['base64'])

Example

Base64 response format

import pika_sdk

ps = pika_sdk.PikaSdk('sk-he2jdus1cbz1dpt4mktgjyvx')
response = ps.generate_image_from_template('open-graph-image-1', {'title': 'From python sdk new'}, 'base64')
print(response)

print("Image base64:", response['data']['base64'])

Base64 output

data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABLAAAAJ2CAYAAABPQHtcAAAAAXNSR0IArs4c6QAAIABJREFUeJzs3XmYJXdZL/Bvna37dM90FghLCBAQkC1BCBAMShLFBJAgKnofroBeFUUF5LrhiihXcV8BQRYVUUAlIewIGPbFmLCFLWwCYZEtzPR+trp/TM/......

Binary response format

from io import BytesIO

import pika_sdk
from PIL import Image

ps = pika_sdk.PikaSdk('sk-he2jdus1cbz1dpt4mktgjyvx')
response = ps.generate_image_from_template('open-graph-image-1', {'title': 'From python sdk new'}, 'binary')

with Image.open(BytesIO(response.content)) as im:
    im.save('og.png')

This example writes the binary image to the file og.png

generate_image_from_template

Use this function to generate an image. It takes in 3 arguments

argument required description
template_id Yes ID of the template (open-graph-image-1, tweet-image-1, beautify-screenshot-1)
modifications Yes Modifications for the selected template.
response_format No base64 or binary (Defaults to base64).

For available templates and their modifications refer image generation api templates

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

pika-sdk-0.2.1.tar.gz (3.7 kB view details)

Uploaded Source

Built Distribution

pika_sdk-0.2.1-py3-none-any.whl (4.6 kB view details)

Uploaded Python 3

File details

Details for the file pika-sdk-0.2.1.tar.gz.

File metadata

  • Download URL: pika-sdk-0.2.1.tar.gz
  • Upload date:
  • Size: 3.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for pika-sdk-0.2.1.tar.gz
Algorithm Hash digest
SHA256 5c9eb8edcdc6bc80596ca1206ae3b19378986f5290c24ae89e97f4433585f625
MD5 18149d9bced441100c51aeae75b30d91
BLAKE2b-256 28ba97f73084748fbbdd62c28840f3ff690ae0092562a91f50a4e6fb814523eb

See more details on using hashes here.

File details

Details for the file pika_sdk-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: pika_sdk-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 4.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for pika_sdk-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 95788bb308a67cc1885c7581181079b5aa9a2b8d2be77058830fc4f368d24f5a
MD5 cebf850c318c63bc03c80d91dbdedd10
BLAKE2b-256 6fe2bb3d8ba506cfdb012a19895bad05979aac69d54c1157990713429169a97f

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