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

Uploaded Source

Built Distribution

openmeter-1.0.0b118-py3-none-any.whl (62.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: openmeter-1.0.0b118.tar.gz
  • Upload date:
  • Size: 56.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 PyPy/7.3.16 Linux/6.5.0-1023-azure

File hashes

Hashes for openmeter-1.0.0b118.tar.gz
Algorithm Hash digest
SHA256 570e6f0901bc628927b51de5002ac8ccba87d57b5e3ff02bd3659ccc48944da3
MD5 8a3ccc4f1efed6f106d08f13784b508f
BLAKE2b-256 4cbc2c7c786417e97c7508cae5a4d73ab48309b9d5f87e889925e0b2acc75fff

See more details on using hashes here.

File details

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

File metadata

  • Download URL: openmeter-1.0.0b118-py3-none-any.whl
  • Upload date:
  • Size: 62.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 PyPy/7.3.16 Linux/6.5.0-1023-azure

File hashes

Hashes for openmeter-1.0.0b118-py3-none-any.whl
Algorithm Hash digest
SHA256 cbc847fcb99bc563adb871412b42efc5b4d97752b4eecf56a78324be7547065b
MD5 607469ad491a757dd4cf1af122cc5ff0
BLAKE2b-256 034efca4f8724161744aca3c06b7d80f3d0750c0cff5a549a81a12348e243d78

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