Python

Detailed technical documentation on using RudderStack’s Python SDK to send events to various destinations

RudderStack’s Python SDK allows you to track your customer event data from your Python code. Once enabled, the event requests hit the RudderStack servers. RudderStack then routes the events to the specified destination platforms as configured by you.

Installing the RudderStack Python SDK

To install the RudderStack Python SDK using pip, run the following command:

Copy
pip install rudder-sdk-python

Initializing the RudderStack Client

To initialize the RudderStack client, run the following code snippet:

Copy
import rudder_analytics

rudder_analytics.write_key = WRITE_KEY
rudder_analytics.data_plane_url = DATA_PLANE_URL

Sending Events from RudderStack

Once the RudderStack client is initialized, you can use it to send relevant customer events from the RudderStack client.

A sample track call is as shown :

Copy
rudder_analytics.track('developer_user_id', 'Simple Track Event', {
  'key1': 'val1'
})

Identify

The identify call lets you identify a visiting user and associate them to their actions.

An example identify call is as shown:

Copy
rudder_analytics.identify('123456', {
    'email': 'name@surname.com',
    'name': 'John Doe',
    'friends': 16
})

The identify method parameters are as described below:

Track

The track call lets you record the customer events, i.e. the actions that they perform, along with any properties associated with them.

An example track call is as shown:

Copy
rudder_analytics.track('123456', 'Article Read', {
    'title': 'The Independence',
    'subtitle': 'Story of the Weak',
    'author': 'John Doe'
})

The track method parameters are as described below:

Page

The page call lets you record your page views with any additional relevant information about the viewed page.

An example page call is as shown:

Copy
rudder_analytics.page('userid', 'Documentation', 'Sample Doc', {
    'url': 'http://rudderstack.com'
})

The page method parameters are as described below:

Screen

The screen call lets you record whenever your user views their mobile screen with any additional relevant information about the screen.

An example screen call is as shown:

Copy
rudder_analytics.screen('userid', 'Settings', 'Brightness', {
    'from': 'Settings Screen'
})

The screen method parameters are as described below:

Group

The group call allows you to link an identified user with a group, such as a company, organization, or an account. It also lets you record any custom traits associated with that group, such as the name of the company, the number of employees, etc.

An example group call is as shown:

Copy
rudder_analytics.group('userid', 'groupid', {
    'name': 'Company',
    'domain': 'IT'
})

The group method parameters are as follows:

Alias

The alias call lets you merge different identities of a known user.

An example alias call is as shown:

Copy
rudder_analytics.alias('previousid', 'userid')

The alias method parameters are as mentioned below:

Error Handling

To handle errors that may occur when sending these events via rudder_analytics you can declare a callback called on_error.

Copy
def on_error(error, events):
    print("Error response:", error)

rudder_analytics.on_error = on_error

Common request responses from the Gateway are as follows

Contact Us

To know more about the RudderStack Python SDK, you can contact us. You can also start a conversation on our Slack channel; we will be happy to talk to you.