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

Uploaded Source

Built Distribution

openmeter-1.0.0b24-py3-none-any.whl (38.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: openmeter-1.0.0b24.tar.gz
  • Upload date:
  • Size: 32.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.0 CPython/3.10.12 Linux/6.2.0-1015-azure

File hashes

Hashes for openmeter-1.0.0b24.tar.gz
Algorithm Hash digest
SHA256 89105164917b5194c0584273af9d7cb357739df605f51b9de08e166ee7931177
MD5 dbe4cdb488212d746361ec94b4d7632d
BLAKE2b-256 4c0c142f8ad3b8e36fcaeaf417bcc57121e2a1a91e213b2189520a70f15613ba

See more details on using hashes here.

File details

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

File metadata

  • Download URL: openmeter-1.0.0b24-py3-none-any.whl
  • Upload date:
  • Size: 38.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.0 CPython/3.10.12 Linux/6.2.0-1015-azure

File hashes

Hashes for openmeter-1.0.0b24-py3-none-any.whl
Algorithm Hash digest
SHA256 df1f90270651882b961ab045d9c0cbe7a67cda9b5b6311c90584b029103d286c
MD5 58b0d91d517408432f0eefc6e9af2836
BLAKE2b-256 3623f652a537b7592440f2740187504d631424da9a576de1c1470aaf4e24ec9f

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