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

Uploaded Source

Built Distribution

openmeter-1.0.0b86-py3-none-any.whl (55.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for openmeter-1.0.0b86.tar.gz
Algorithm Hash digest
SHA256 ef5b93059aea5c7fb93712828af6c09744ae82af1270f16dc7a42680819bd329
MD5 ca68ea5407014d6784601b0834c070aa
BLAKE2b-256 1197924435096334242dfabc42afa4e959d804d7cdc707970d5ff9911fd49741

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for openmeter-1.0.0b86-py3-none-any.whl
Algorithm Hash digest
SHA256 f67f0a16e79539934c8e90dccb9af5725c05cf88ceb68eb2b37cb4a06f3cc50a
MD5 b4b2a50daeec1ca19eaa3d6692ec8b93
BLAKE2b-256 42f3bc12443053081c9553bc5b3c6ef8367bd3d2fcdaced4b3e6accd2c8a5861

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