Skip to main content

Client for OpenMeter: Real-Time and Scalable Usage Metering

Project description

OpenMeter Python SDK

[https://pypi.org/project/openmeter](On PyPI)

Prerequisites

Python version: >= 3.9

Install

The Python SDK is in preview mode.

pip install openmeter

Quickstart

The client can be initialized with openmeter.Client():

from os import environ
from openmeter import Client

ENDPOINT = environ.get("OPENMETER_ENDPOINT") or "http://localhost:8888"

# it's recommended to also set the Accept header at the client level
client = Client(
    endpoint=ENDPOINT,
    headers={"Accept": "application/json"},
)

Async client can be initialized by importing the Client from openmeter.aio.

Ingest events:

from cloudevents.http import CloudEvent
from cloudevents.conversion import to_dict

event = CloudEvent(
    attributes={
        "type": "tokens",
        "source": "openmeter-python",
        "subject": "user-id",
    },
    data={
        "prompt_tokens": 5,
        "completion_tokens": 10,
        "total_tokens": 15,
        "model": "gpt-3.5-turbo",
    },
)

resp = client.ingest_events(to_dict(event))

Publish

Update version number in pyproject.toml. Run the following commands:

poetry config pypi-token.pypi {your_pypi_api_token}
poetry publish --build

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

openmeter-1.0.0b59.tar.gz (38.2 kB view details)

Uploaded Source

Built Distribution

openmeter-1.0.0b59-py3-none-any.whl (44.6 kB view details)

Uploaded Python 3

File details

Details for the file openmeter-1.0.0b59.tar.gz.

File metadata

  • Download URL: openmeter-1.0.0b59.tar.gz
  • Upload date:
  • Size: 38.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.10.12 Linux/6.5.0-1016-azure

File hashes

Hashes for openmeter-1.0.0b59.tar.gz
Algorithm Hash digest
SHA256 86809d4e16060f5850928b974026a326a369e09539069a9cc85fd33a366bca7d
MD5 046d3cc0cfd71788db9b2e3ed5843eab
BLAKE2b-256 3352ebb5525905cdd0a9b22a753cf23d55c83bbe7bf33c74f1fad6eaff970c85

See more details on using hashes here.

File details

Details for the file openmeter-1.0.0b59-py3-none-any.whl.

File metadata

  • Download URL: openmeter-1.0.0b59-py3-none-any.whl
  • Upload date:
  • Size: 44.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.10.12 Linux/6.5.0-1016-azure

File hashes

Hashes for openmeter-1.0.0b59-py3-none-any.whl
Algorithm Hash digest
SHA256 41d6c218456b2e74cd02e9405f33586e853b11bb2919df6e02736719f61e8501
MD5 f0cf0ec81b78ac774ebb83f70553d4e3
BLAKE2b-256 2587fe4ddff06c26495aefe81c8412a12985d48327755a42baf4ae7bca69829c

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 Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page