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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: openmeter-1.0.0b127.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.0b127.tar.gz
Algorithm Hash digest
SHA256 39332bd47e134bf7ee64b66672481da05c512cb98e37c8e1af5a4f13676bb6ed
MD5 2b5e5b05a143fd0d6e967bb0ba46c2bf
BLAKE2b-256 7a2314f1e14ae7e743198dac5bc45ab5c0308513e83dfb40d790a459acc1bebd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: openmeter-1.0.0b127-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.0b127-py3-none-any.whl
Algorithm Hash digest
SHA256 ec9aba29e1550609e7d03850edb1fae4ecd6ae6ef6985c045f4f9c741d218181
MD5 64cf9ca087778e582712b7555f63612e
BLAKE2b-256 6bcc26ea7e53a549734afc86e63a7f5b3d9c64ca1c0ffc0ff8fa846a3cd24bc1

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