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

Uploaded Source

Built Distribution

openmeter-1.0.0b126-py3-none-any.whl (68.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for openmeter-1.0.0b126.tar.gz
Algorithm Hash digest
SHA256 081b891ab7dac675bb97ef2810f696b63fac98ff18ac66c6c23b1cc968d1689f
MD5 8cb8ea47212433d776ea66eaf491cfe3
BLAKE2b-256 cd585088d9265e1017ff229f504c134d9014afa371469df662767167c79e351e

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for openmeter-1.0.0b126-py3-none-any.whl
Algorithm Hash digest
SHA256 9e29ebb10ea8daa44907e18939e13fa092a23d3bf3c075196145ebeebdf9e004
MD5 31253af5a85bc371997e0198906d0193
BLAKE2b-256 1062c6a601f77631bcbd04a45cbb15d488b11d8e75744d3640943f3232d75464

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