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

Uploaded Source

Built Distribution

openmeter-1.0.0b38-py3-none-any.whl (42.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for openmeter-1.0.0b38.tar.gz
Algorithm Hash digest
SHA256 c22fcf1c0fdb52cd6a1c8269ffcacbbc9f0d4272220f374daef9447222245d5a
MD5 7b7e95c675218748c51b914fbb2294a4
BLAKE2b-256 9e9b3ff926629e06e0bf24e87dd29de8089548c51c916e21e212cbde222ba6e0

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for openmeter-1.0.0b38-py3-none-any.whl
Algorithm Hash digest
SHA256 34afa590e271d18023ca5c06b05a62ccbbb18acb3169a92ba044554a4d19af89
MD5 0be3278f773ad2f415a4a11757fdd75f
BLAKE2b-256 19a5ffdc4f8d59c7284300ae56e9a483f91bb391c9d5a6dd1073b3509750b739

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