Skip to content

Add host docs to README #3

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

Merged
nunofgs merged 2 commits into from
Nov 2, 2023
Merged

Add host docs to README #3

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ab587b4
Add host docs to README
nunofgs Oct 31, 2023
27b6795
Add documentation links
nunofgs Nov 2, 2023
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
23 changes: 22 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,30 @@ pip3 install git+http://github.com/customerio/cdp-analytics-python
## Usage

```python
from customerio_cdp_analytics import analytics
from customerio import analytics

analytics.write_key = 'YOUR_WRITE_KEY'

analytics.track(user_id=4, event='order_complete')
```

## Other Regions

If you're using a [different data center](https://customer.io/docs/accounts-and-workspaces/data-centers/) such as our EU region, you can specify an alternate endpoint:

```python
from customerio import analytics

analytics.write_key = 'YOUR_WRITE_KEY'
analytics.host = 'https://cdp-eu.customer.io'

analytics.track(user_id=4, event='order_complete')
```

## Documentation

The links below contain more detailed documentation on how to use this library:

* [Documentation](https://customer.io/docs/cdp/sources/connections/servers/python/)
* [Specs](https://customer.io/docs/cdp/sources/source-spec/source-events/)
* [PyPi](https://pypi.org/project/customerio-cdp-analytics/)