This documentation provides guidance on how to integrate the June SDK with your Python application. June SDK is a powerful library for tracking user interactions and events, offering similar functionality to the underlying Segment SDK.

To install the June SDK in your Python project, use the PIP package manager:

1
pip install june-analytics-python

First, you'll need to import the SDK into your application. Next, instantiate the client using the write key you've received when you created your June account:

1
from june import analytics
2

3
analytics.write_key = "YOUR_WRITE_KEY"

Now you can use the analytics instance to track events, identify users, and more.

The June Python SDK allows you to configure several settings according to your needs. The available configuration parameters are:

Here's an example of how to configure the client:

1
from june import analytics
2

3
analytics.write_key = "YOUR_WRITE_KEY"
4
analytics.host = "YOUR_HOST"
5
analytics.debug = True
6
analytics.max_queue_size = 10000
7
analytics.send = True
8
analytics.on_error = lambda error, items: print(error, items)
9
analytics.gzip = True
10
analytics.max_retries = 5
11
analytics.sync_mode = False
12
analytics.timeout = 10

To track events, you can use the track method:

1
analytics.track(
2
  user_id="USER_ID",
3
  event="Signed In",
4
  properties={"browser": "chrome"},
5
)

Parameters:

To identify users, you can use the identify method:

1
analytics.identify(
2
  user_id="USER_ID",
3
  traits={
4
    "email": "test@example.com",
5
    # Optional
6
    "name": "Joe Bloggs",
7
    "avatar": "https://avatar.com/0sd9fsd8y97a0sf99asd.png",
8
    # Add anything else about the user here
9
  },
10
)

Parameters:

To group users by organization or company, use the group method:

1
analytics.group(
2
  user_id="USER_ID",
3
  group_id="GROUP_ID",
4
  traits={
5
    "name": "Acme Inc",
6
    # Optional
7
    "avatar": "https://avatar.com/0sd9fsd8y97a0sf99asd.png",
8
    # Add anything else about the company here
9
  },
10
)

Parameters:

In serverless environemnts like AWS Lambda, your environment may finish the code execution before June SDK is able to send events to June API.

You can use the flush method to send all queued events to June or you can configure the SDK to flush events automatically.

1
analytics.flush()

If you set sync_mode to True, the SDK will flush events automatically after every event.

1
analytics.sync_mode = True