Client for the Amplitude HTTP V1 and V2 API (https://developers.amplitude.com/docs).
Project description
amplitude-python-sdk
Unofficial SDK for the Amplitude HTTP API, providing a user-friendly interface through Pydantic models.
See the Amplitude docs for more information on the various API methods and their parameters.
WARNING: This library is in very early development, and APIs are not guaranteed to be stable. Please bear that in mind when using this library.
Installation
pip install amplitude-python-sdk
Dependencies
- pydantic is used to create cleaner and more readable data models within this library.
- requests is used to handle all HTTP interactions with the Amplitude API.
Usage
Methods supported
Currently, only the Identify API and the HTTP API V2 are supported. Support for other API methods coming soon!
Identify API Example
import logging
from amplitude_python_sdk.common.exceptions import AmplitudeAPIException
from amplitude_python_sdk.v1.client import AmplitudeV1APIClient
from amplitude_python_sdk.v1.models.identify import Identification, UserProperties
client = AmplitudeV1APIClient(api_key='<YOUR API KEY HERE>')
try:
resp = client.identify([Identification(user_id='example', user_properties=UserProperties()])
except AmplitudeAPIException:
logging.exception('Failed to send identify request to Amplitude')
Event API Client Example
import logging
from amplitude_python_sdk.common.exceptions import AmplitudeAPIException
from amplitude_python_sdk.v2.clients.event_client import EventAPIClient
from amplitude_python_sdk.v2.models.event import Event
from amplitude_python_sdk.v2.models.event.options import EventAPIOptions
client = EventAPIClient(api_key='<YOUR API KEY HERE>')
try:
events = [
Event(
user_id='example',
event_type='Clicked on Foo',
event_properties={
'foo_id': 'bar',
'click_position': 5,
}
)
]
client.upload(
events=events,
options=EventAPIOptions(min_id_length=1),
)
except AmplitudeAPIException:
logging.exception('Failed to log event to Amplitude')
Batch Event Upload API Example
Exactly the same as the Event V2 API example, just substitute client.batch_upload
for client.upload
.
Project details
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 amplitude_python_sdk-0.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a5687a30a5c10b8e9d1673e45673eb834111cdaeb6ae404a2254166342c11351 |
|
MD5 | e7a5f69a610df6407fdaf080cc5cc8bd |
|
BLAKE2b-256 | e2b30fd93d3ccf444ab3f353b3e55edc46ddd79547a149481679dd6d53370997 |
Hashes for amplitude_python_sdk-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0eb97fd5db3e446612fec85714be4aa8a12946d35bc4ee719728fc8a11e3e7bb |
|
MD5 | 3cae0e8cbba7f634e063786c6d2f850c |
|
BLAKE2b-256 | 972f6204d40d23c0870a3d884131b6376938eff933909f402c332a0f9cf1eb2d |