Skip to content

fix: apply ruff formatting to unblock lint CI for release/analytics/5.3.0 #187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Copilot wants to merge 1 commit into from
Closed

fix: apply ruff formatting to unblock lint CI for release/analytics/5.3.0 #187

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ python -m twine upload dist/* # Publish to PyPI
local_config = mixpanel.LocalFlagsConfig(
api_host="api-eu.mixpanel.com", # EU data residency
enable_polling=True,
polling_interval_in_seconds=90
polling_interval_in_seconds=90,
)
mp = Mixpanel(token, local_flags_config=local_config)
```
Expand Down
36 changes: 18 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ from mixpanel import Mixpanel
mp = Mixpanel(YOUR_TOKEN)

# tracks an event with certain properties
mp.track(DISTINCT_ID, 'button clicked', {'color' : 'blue', 'size': 'large'})
mp.track(DISTINCT_ID, "button clicked", {"color": "blue", "size": "large"})

# sends an update to a user profile
mp.people_set(DISTINCT_ID, {'$first_name' : 'Ilya', 'favorite pizza': 'margherita'})
mp.people_set(DISTINCT_ID, {"$first_name": "Ilya", "favorite pizza": "margherita"})
```

You can use an instance of the Mixpanel class for sending all of your events
Expand All @@ -50,18 +50,18 @@ from mixpanel import Mixpanel, ServiceAccountCredentials
# Create credentials object
# Service accounts replace api_key/api_secret for authentication
credentials = ServiceAccountCredentials(
username='YOUR_SERVICE_ACCOUNT_USERNAME',
secret='YOUR_SERVICE_ACCOUNT_SECRET',
project_id='YOUR_PROJECT_ID'
username="YOUR_SERVICE_ACCOUNT_USERNAME",
secret="YOUR_SERVICE_ACCOUNT_SECRET",
project_id="YOUR_PROJECT_ID",
)

# Token identifies the project and is used for event tracking
# Credentials are used for endpoints that require authentication
mp = Mixpanel(YOUR_TOKEN, credentials=credentials)

# Event tracking operations use the token (sent in payload)
mp.track(DISTINCT_ID, 'button clicked', {'color': 'blue'})
mp.people_set(DISTINCT_ID, {'$first_name': 'John'})
mp.track(DISTINCT_ID, "button clicked", {"color": "blue"})
mp.people_set(DISTINCT_ID, {"$first_name": "John"})
```

Service account credentials can also be used with custom consumers like `BufferedConsumer`:
Expand All @@ -70,9 +70,9 @@ Service account credentials can also be used with custom consumers like `Buffere
from mixpanel import Mixpanel, BufferedConsumer, ServiceAccountCredentials

credentials = ServiceAccountCredentials(
username='YOUR_SERVICE_ACCOUNT_USERNAME',
secret='YOUR_SERVICE_ACCOUNT_SECRET',
project_id='YOUR_PROJECT_ID'
username="YOUR_SERVICE_ACCOUNT_USERNAME",
secret="YOUR_SERVICE_ACCOUNT_SECRET",
project_id="YOUR_PROJECT_ID",
)

# Option 1: Pass credentials to the consumer constructor
Expand All @@ -83,7 +83,7 @@ mp = Mixpanel(YOUR_TOKEN, consumer=consumer)
mp = Mixpanel(YOUR_TOKEN, credentials=credentials)

# Event tracking uses the token (sent in payload)
mp.track(DISTINCT_ID, 'event_name')
mp.track(DISTINCT_ID, "event_name")
```

Service account credentials are only used for the `/import` endpoint and feature flags. Regular event tracking operations (`track`, `people_set`, `group_set`) use the token provided in the constructor, which is sent in the event payload.
Expand All @@ -97,20 +97,20 @@ from mixpanel import Mixpanel, ServiceAccountCredentials
from mixpanel.flags.types import LocalFlagsConfig

credentials = ServiceAccountCredentials(
username='YOUR_SERVICE_ACCOUNT_USERNAME',
secret='YOUR_SERVICE_ACCOUNT_SECRET',
project_id='YOUR_PROJECT_ID'
username="YOUR_SERVICE_ACCOUNT_USERNAME",
secret="YOUR_SERVICE_ACCOUNT_SECRET",
project_id="YOUR_PROJECT_ID",
)

# Token identifies the project for event tracking, credentials handle authentication
mp = Mixpanel(
YOUR_TOKEN,
credentials=credentials,
local_flags_config=LocalFlagsConfig()
YOUR_TOKEN, credentials=credentials, local_flags_config=LocalFlagsConfig()
)

# Feature flag requests will use service account authentication
variant = mp.local_flags.get_variant_value('my-flag', fallback_value=False, context={...})
variant = mp.local_flags.get_variant_value(
"my-flag", fallback_value=False, context={...}
)
```

**Note**: When using service account credentials, the `token` parameter in the `Mixpanel` constructor is still required for event tracking operations (`track`, `people_set`, etc.) since the token is included in the event data payload. However, feature flag operations use the `project_id` from credentials instead of the token for authentication.
Expand Down
Loading