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.0b48.tar.gz (36.4 kB view details)

Uploaded Source

Built Distribution

openmeter-1.0.0b48-py3-none-any.whl (42.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: openmeter-1.0.0b48.tar.gz
  • Upload date:
  • Size: 36.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.10.12 Linux/6.2.0-1019-azure

File hashes

Hashes for openmeter-1.0.0b48.tar.gz
Algorithm Hash digest
SHA256 e0dd11f477fdd79192fa8ff68807a8da7f13163c28fe2d4c594d2599fc8d5031
MD5 f1539812f0b26790966c26031ca83763
BLAKE2b-256 79a8206246e661995d28ff4d78fd8f1d48289d8b30114763977083f211495cdc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: openmeter-1.0.0b48-py3-none-any.whl
  • Upload date:
  • Size: 42.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.10.12 Linux/6.2.0-1019-azure

File hashes

Hashes for openmeter-1.0.0b48-py3-none-any.whl
Algorithm Hash digest
SHA256 165b7071c18c3a7ea4c070bec2c6993b4e07ea29cdde03beb6c2c68a78cfa51a
MD5 3acfff1a123a96f96d236a2ba7feecea
BLAKE2b-256 20c7386ac8c7667ce27d2f1c3f35fc40b1e060b51a4aa070fac3c9089f178706

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