Skip to main content

Python SDK for Cloudglue API

Project description

Cloudglue Python SDK

PyPI - Version License Discord

Cloudglue makes it easy to turn video into LLM ready data. Official Python SDK for the Cloudglue API.

📖 Resources

By using this SDK, you agree to the Cloudglue Terms of Service and acknowledge our Privacy Policy.

Installation

You can install the Cloudglue Python SDK using pip:

pip install cloudglue

Quick Start

from cloudglue import Cloudglue

# Initialize the client
client = Cloudglue(api_key="your_api_key")  # Or use CLOUDGLUE_API_KEY env variable

# Define your messages
messages = [
    {"role": "user", "content": "What are aligned video captions?"}
]

# Make an API request
response = client.chat.completions.create(
    messages=messages,
    model="nimbus-001",
    collections=["abc123"], # Assumes collection already exists, otherwise create one first then reference here by collection id    
)

# Get the generated text
generated_text = response.choices[0].message.content
print(generated_text)

Development

Prerequisites

  • Python 3.10+
  • Make (for build tasks)
  • Git

Setup

Clone the repository and set up the development environment:

git clone https://github.com/cloudglue/cloudglue-python.git
cd cloudglue-python

brew install openapi-generator
make setup  # This will set up the virtual environment

# Initialize the API spec Git submodule
make submodule-init

API Specification

The OpenAPI specification is maintained in a separate repository and included as a Git submodule:

# Update the API spec to the latest version
make submodule-update

# After updating the spec, regenerate the SDK
make generate

Building

make generate  # Generate SDK from OpenAPI spec
make build     # Build the package

Project Structure

Project directory structure described below:

cloudglue/
├── __init__.py       # Main package initialization
├── client/           # Custom client wrapper code
│   └── main.py       # Cloudglue class implementation  
└── sdk/              # Auto-generated API code
dist/                 # Pre-built package dist
spec/                 # Git submodule with OpenAPI specification
└── spec/             # Nested spec directory
    └── openapi.json  # OpenAPI spec file

Contact

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

cloudglue-0.7.12.tar.gz (210.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cloudglue-0.7.12-py3-none-any.whl (558.8 kB view details)

Uploaded Python 3

File details

Details for the file cloudglue-0.7.12.tar.gz.

File metadata

  • Download URL: cloudglue-0.7.12.tar.gz
  • Upload date:
  • Size: 210.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.8

File hashes

Hashes for cloudglue-0.7.12.tar.gz
Algorithm Hash digest
SHA256 9ee0ccde70717e3abc9b1777cef4abd093f1595b0df3cb5a7145b7d4f94286b7
MD5 fca0c398d3787309ebe11a841ca4c862
BLAKE2b-256 52cfa9d5a4fe9faa6abb189c0bdebb647db3486138c3e16cd7b74b6816db97fa

See more details on using hashes here.

File details

Details for the file cloudglue-0.7.12-py3-none-any.whl.

File metadata

  • Download URL: cloudglue-0.7.12-py3-none-any.whl
  • Upload date:
  • Size: 558.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.8

File hashes

Hashes for cloudglue-0.7.12-py3-none-any.whl
Algorithm Hash digest
SHA256 a555157b15e39bd3295f71b8176ce3b422d07b3352cb82e8d19f577d15e70db0
MD5 963d74a08f9b5f43c027cef3f8d62818
BLAKE2b-256 a17df82f973e2da6c5a58ec199022e3f1d653a17e23ef8425e02ac90932d7bad

See more details on using hashes here.

Supported by

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