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

Uploaded Source

Built Distribution

openmeter-1.0.0b185-py3-none-any.whl (71.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for openmeter-1.0.0b185.tar.gz
Algorithm Hash digest
SHA256 bfa2b336881c21d6d7766d0a354d41d7f9ad9d9e5aa45a71f2e6cc9b39ecf47d
MD5 899feaab9a50bde8a47472f7a28aa6ff
BLAKE2b-256 2322f625f66f4da3f4d7382b519fd3b298aaa9a63fe96c9bb5c1711ad1af6ae5

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for openmeter-1.0.0b185-py3-none-any.whl
Algorithm Hash digest
SHA256 0e29a54bd0575e4fe0c6c4576a50b6baf554ee6274a455fcbd3f389a38ec67cb
MD5 0d08c2b1be69d4d13f87baece7a3a503
BLAKE2b-256 a95a8eacf6f7b4f97df8aa7e93e7c090d937dc6d778d805279270224564d3b3d

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