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

Uploaded Source

Built Distribution

openmeter-1.0.0b64-py3-none-any.whl (45.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: openmeter-1.0.0b64.tar.gz
  • Upload date:
  • Size: 38.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.10.12 Linux/6.5.0-1018-azure

File hashes

Hashes for openmeter-1.0.0b64.tar.gz
Algorithm Hash digest
SHA256 4ae7b663c03699743758bad28c996435e256203425add9f5d7ef7ed77b118f0f
MD5 f85b508d604b4964049ebe9a2539070b
BLAKE2b-256 9a52075ff7a6e84393b6288363de80c3b031b18860e023861459e98638f56ab2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: openmeter-1.0.0b64-py3-none-any.whl
  • Upload date:
  • Size: 45.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.10.12 Linux/6.5.0-1018-azure

File hashes

Hashes for openmeter-1.0.0b64-py3-none-any.whl
Algorithm Hash digest
SHA256 65e65e7b1bee864981b6e78dd5b1528bca78367249fa3c57591e8112d1a17442
MD5 b751a82b2d208601d0550c2d1aee177a
BLAKE2b-256 0dc2087a0bc3466ac1d10264f5d5ccf256f2751dd639a130fd9805280734129b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page