Simple and easy to use python package for utilizing vayu billing system
Project description
Vayu python client
Prerequisites
- Python 3.7 and above
- Install the
vayu-client
package (pip install vayu-client
)
End-to-End Code Example
To illustrate how to use the Vayu
library for sending events to Vayu's API, here is a complete code snippet. This example combines all the steps detailed in previous sections:
from datetime import datetime
from vayu import Vayu
# Initialize vayu
vayu = Vayu('YOUR_ACCESS_KEY')
# Create and send the event
vayu.send_events([{
'name': 'api_call',
'timestamp': datetime.now(),
'customerAlias': 'customer_12345',
'data': {
'key1': 'processing_duration',
'key2': 'api_url'
},
'ref': '4f6cf35x-2c4y-483z-a0a9-158621f77a21'
}])
That's it! This example demonstrates how to send an event using Python and the Vayu
library.
Step-by-step Guide
Step 1: Import Vayu
The first step is to import the Vayu
class from the Vayu
package.
from vayu import Vayu
Step 2: Initialize the Client
After importing, create a new Vayu
instance and pass the api key
vayu = Vayu('YOUR_API_KEY')
Step 3: Send Events
Finally, you can send events to the Vayu API by using the send_events
method. The method takes a list of dictionaries, where each dictionary represents a single event. Each event dictionary should contain the following fields:
name
(string - required): A distinctive label assigned to an event. It serves as a critical identifier for categorizing and pricing events.timestamp
(datetime): The exact moment when the event occurs.customerAlias
(string): A unique identifier for each customer, which may be pseudonymous or obfuscated.data
(object): A schema-less JSON object containing miscellaneous attributes and metrics associated with the event.ref
(string, optional): A UUID or other high-entropy string serving as an immutable reference for each event entry.
Example:
vayu.send_events([{
'name': 'api_call',
'timestamp': datetime.now(),
'customerAlias': 'customer_12345',
'data': {
'key1': 'processing_duration',
'key2': 'api_url'
},
'ref': '4f6cf35x-2c4y-483z-a0a9-158621f77a21'
}])
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
Built Distribution
Hashes for vayu_client-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d9af02db798b7f890a76d9e94d7a4eb343a2c8cc8f176c69e8a9feddaaa4e1ec |
|
MD5 | d0af394e9904f0ab077ad068e63cbcaa |
|
BLAKE2b-256 | dfb5603b5a1990d03b9d41b3f131b7aae810ae05c078c12babe32e7d83b95ea8 |