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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: openmeter-1.0.0b58.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.0b58.tar.gz
Algorithm Hash digest
SHA256 e1ae168b2ee692c417ae19ab3555c1cf26bd100845707363afd8c8172b3431df
MD5 272e90d01ce662334102a2d0dbf82fde
BLAKE2b-256 696506a8f5d12036974db9fe8bce45ac79158a6b9fcc87472bf5d9f196d0098d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: openmeter-1.0.0b58-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.0b58-py3-none-any.whl
Algorithm Hash digest
SHA256 43a2f9391bf29795d9c55e01fe7e6097e156c4196ec468857d3f2e0dcc850e84
MD5 a2e8c71fa238e230bd91bd5682883050
BLAKE2b-256 c4b1d3064b917420f785841545c4b4bbafd3576e00965a5c0210765883ebd51a

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