https://github.com/GetStream/stream-python
Python Client - Build Activity Feeds & Streams with GetStream.io
https://github.com/GetStream/stream-python
activity-feed feed getstream-io news-feed notification-feed python stream-python timeline
Last synced: 6 months ago
JSON representation
Python Client - Build Activity Feeds & Streams with GetStream.io
- Host: GitHub
- URL: https://github.com/GetStream/stream-python
- Owner: GetStream
- License: bsd-3-clause
- Created: 2014-05-27T11:51:50.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2023-10-25T16:58:59.000Z (about 2 years ago)
- Last Synced: 2024-09-19T03:25:33.222Z (over 1 year ago)
- Topics: activity-feed, feed, getstream-io, news-feed, notification-feed, python, stream-python, timeline
- Language: Python
- Homepage: https://getstream.io
- Size: 561 KB
- Stars: 142
- Watchers: 43
- Forks: 40
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Official Python SDK for [Stream Feeds](https://getstream.io/activity-feeds/)
[](https://github.com/GetStream/stream-python/actions) [](http://badge.fury.io/py/stream-python) 
Official Python API client for Stream Feeds, a web service for building scalable newsfeeds and activity streams.
Explore the docs »
Django Code Sample
·
Report Bug
·
Request Feature
## 📝 About Stream
> 💡 Note: this is a library for the **Feeds** product. The Chat SDKs can be found [here](https://getstream.io/chat/docs/).
You can sign up for a Stream account at our [Get Started](https://getstream.io/get_started/) page.
You can use this library to access feeds API endpoints server-side.
For the client-side integrations (web and mobile) have a look at the JavaScript, iOS and Android SDK libraries ([docs](https://getstream.io/activity-feeds/)).
> 💡 We have a Django integration available [here](https://github.com/GetStream/stream-django).
## ⚙️ Installation
```bash
$ pip install stream-python
```
## 📚 Full documentation
Documentation for this Python client are available at the [Stream website](https://getstream.io/docs/?language=python).
## ✨ Getting started
```python
import datetime
# Create a new client
import stream
client = stream.connect('YOUR_API_KEY', 'API_KEY_SECRET')
# Create a new client specifying data center location
client = stream.connect('YOUR_API_KEY', 'API_KEY_SECRET', location='us-east')
# Find your API keys here https://getstream.io/dashboard/
# Create a feed object
user_feed_1 = client.feed('user', '1')
# Get activities from 5 to 10 (slow pagination)
result = user_feed_1.get(limit=5, offset=5)
# (Recommended & faster) Filter on an id less than the given UUID
result = user_feed_1.get(limit=5, id_lt="e561de8f-00f1-11e4-b400-0cc47a024be0")
# Create a new activity
activity_data = {'actor': 1, 'verb': 'tweet', 'object': 1, 'foreign_id': 'tweet:1'}
activity_response = user_feed_1.add_activity(activity_data)
# Create a bit more complex activity
activity_data = {'actor': 1, 'verb': 'run', 'object': 1, 'foreign_id': 'run:1',
'course': {'name': 'Golden Gate park', 'distance': 10},
'participants': ['Thierry', 'Tommaso'],
'started_at': datetime.datetime.now()
}
user_feed_1.add_activity(activity_data)
# Remove an activity by its id
user_feed_1.remove_activity("e561de8f-00f1-11e4-b400-0cc47a024be0")
# or by foreign id
user_feed_1.remove_activity(foreign_id='tweet:1')
# Follow another feed
user_feed_1.follow('flat', '42')
# Stop following another feed
user_feed_1.unfollow('flat', '42')
# List followers/following
following = user_feed_1.following(offset=0, limit=2)
followers = user_feed_1.followers(offset=0, limit=10)
# Creates many follow relationships in one request
follows = [
{'source': 'flat:1', 'target': 'user:1'},
{'source': 'flat:1', 'target': 'user:2'},
{'source': 'flat:1', 'target': 'user:3'}
]
client.follow_many(follows)
# Batch adding activities
activities = [
{'actor': 1, 'verb': 'tweet', 'object': 1},
{'actor': 2, 'verb': 'watch', 'object': 3}
]
user_feed_1.add_activities(activities)
# Add an activity and push it to other feeds too using the `to` field
activity = {
"actor":"1",
"verb":"like",
"object":"3",
"to":["user:44", "user:45"]
}
user_feed_1.add_activity(activity)
# Retrieve an activity by its ID
client.get_activities(ids=[activity_id])
# Retrieve an activity by the combination of foreign_id and time
client.get_activities(foreign_id_times=[
(foreign_id, activity_time),
])
# Enrich while getting activities
client.get_activities(ids=[activity_id], enrich=True, reactions={"counts": True})
# Update some parts of an activity with activity_partial_update
set = {
'product.name': 'boots',
'colors': {
'red': '0xFF0000',
'green': '0x00FF00'
}
}
unset = [ 'popularity', 'details.info' ]
# ...by ID
client.activity_partial_update(id=activity_id, set=set, unset=unset)
# ...or by combination of foreign_id and time
client.activity_partial_update(foreign_id=foreign_id, time=activity_time, set=set, unset=unset)
# Generating user token for client side usage (JS client)
user_token = client.create_user_token("user-42")
# Javascript client side feed initialization
# client = stream.connect(apiKey, userToken, appId);
# Generate a redirect url for the Stream Analytics platform to track
# events/impressions on url clicks
impression = {
'content_list': ['tweet:1', 'tweet:2', 'tweet:3'],
'user_data': 'tommaso',
'location': 'email',
'feed_id': 'user:global'
}
engagement = {
'content': 'tweet:2',
'label': 'click',
'position': 1,
'user_data': 'tommaso',
'location': 'email',
'feed_id':
'user:global'
}
events = [impression, engagement]
redirect_url = client.create_redirect_url('http://google.com/', 'user_id', events)
```
### Async code usage
```python
import datetime
import stream
client = stream.connect('YOUR_API_KEY', 'API_KEY_SECRET', use_async=True)
# Create a new client specifying data center location
client = stream.connect('YOUR_API_KEY', 'API_KEY_SECRET', location='us-east', use_async=True)
# Find your API keys here https://getstream.io/dashboard/
# Create a feed object
user_feed_1 = client.feed('user', '1')
# Get activities from 5 to 10 (slow pagination)
result = await user_feed_1.get(limit=5, offset=5)
# (Recommended & faster) Filter on an id less than the given UUID
result = await user_feed_1.get(limit=5, id_lt="e561de8f-00f1-11e4-b400-0cc47a024be0")
# Create a new activity
activity_data = {'actor': 1, 'verb': 'tweet', 'object': 1, 'foreign_id': 'tweet:1'}
activity_response = await user_feed_1.add_activity(activity_data)
# Create a bit more complex activity
activity_data = {'actor': 1, 'verb': 'run', 'object': 1, 'foreign_id': 'run:1',
'course': {'name': 'Golden Gate park', 'distance': 10},
'participants': ['Thierry', 'Tommaso'],
'started_at': datetime.datetime.now()
}
await user_feed_1.add_activity(activity_data)
# Remove an activity by its id
await user_feed_1.remove_activity("e561de8f-00f1-11e4-b400-0cc47a024be0")
# or by foreign id
await user_feed_1.remove_activity(foreign_id='tweet:1')
# Follow another feed
await user_feed_1.follow('flat', '42')
# Stop following another feed
await user_feed_1.unfollow('flat', '42')
# List followers/following
following = await user_feed_1.following(offset=0, limit=2)
followers = await user_feed_1.followers(offset=0, limit=10)
# Creates many follow relationships in one request
follows = [
{'source': 'flat:1', 'target': 'user:1'},
{'source': 'flat:1', 'target': 'user:2'},
{'source': 'flat:1', 'target': 'user:3'}
]
await client.follow_many(follows)
# Batch adding activities
activities = [
{'actor': 1, 'verb': 'tweet', 'object': 1},
{'actor': 2, 'verb': 'watch', 'object': 3}
]
await user_feed_1.add_activities(activities)
# Add an activity and push it to other feeds too using the `to` field
activity = {
"actor":"1",
"verb":"like",
"object":"3",
"to":["user:44", "user:45"]
}
await user_feed_1.add_activity(activity)
# Retrieve an activity by its ID
await client.get_activities(ids=[activity_id])
# Retrieve an activity by the combination of foreign_id and time
await client.get_activities(foreign_id_times=[
(foreign_id, activity_time),
])
# Enrich while getting activities
await client.get_activities(ids=[activity_id], enrich=True, reactions={"counts": True})
# Update some parts of an activity with activity_partial_update
set = {
'product.name': 'boots',
'colors': {
'red': '0xFF0000',
'green': '0x00FF00'
}
}
unset = [ 'popularity', 'details.info' ]
# ...by ID
await client.activity_partial_update(id=activity_id, set=set, unset=unset)
# ...or by combination of foreign_id and time
await client.activity_partial_update(foreign_id=foreign_id, time=activity_time, set=set, unset=unset)
# Generating user token for client side usage (JS client)
user_token = client.create_user_token("user-42")
# Javascript client side feed initialization
# client = stream.connect(apiKey, userToken, appId);
# Generate a redirect url for the Stream Analytics platform to track
# events/impressions on url clicks
impression = {
'content_list': ['tweet:1', 'tweet:2', 'tweet:3'],
'user_data': 'tommaso',
'location': 'email',
'feed_id': 'user:global'
}
engagement = {
'content': 'tweet:2',
'label': 'click',
'position': 1,
'user_data': 'tommaso',
'location': 'email',
'feed_id':
'user:global'
}
events = [impression, engagement]
redirect_url = client.create_redirect_url('http://google.com/', 'user_id', events)
```
[JS client](http://github.com/getstream/stream-js).
## ✍️ Contributing
=======
We welcome code changes that improve this library or fix a problem, please make sure to follow all best practices and add tests if applicable before submitting a Pull Request on Github. We are very happy to merge your code in the official repository. Make sure to sign our [Contributor License Agreement (CLA)](https://docs.google.com/forms/d/e/1FAIpQLScFKsKkAJI7mhCr7K9rEIOpqIDThrWxuvxnwUq2XkHyG154vQ/viewform) first. See our [license file](./LICENSE) for more details.
## 🧑💻 We are hiring!
We've recently closed a [$38 million Series B funding round](https://techcrunch.com/2021/03/04/stream-raises-38m-as-its-chat-and-activity-feed-apis-power-communications-for-1b-users/) and we keep actively growing.
Our APIs are used by more than a billion end-users, and you'll have a chance to make a huge impact on the product within a team of the strongest engineers all over the world.
Check out our current openings and apply via [Stream's website](https://getstream.io/team/#jobs).