Official Python SDK for Stream Feeds
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
💡 Note: this is a library for the Feeds product. The Chat SDKs can be found here.
You can sign up for a Stream account at our 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).
💡 We have a Django integration available here.
$ pip install stream-pythonDocumentation for this Python client are available at the Stream website.
importdatetime# Create a new clientimportstreamclient=stream.connect('YOUR_API_KEY', 'API_KEY_SECRET')
# Create a new client specifying data center locationclient=stream.connect('YOUR_API_KEY', 'API_KEY_SECRET', location='us-east')
# Find your API keys here https://getstream.io/dashboard/# Create a feed objectuser_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 UUIDresult=user_feed_1.get(limit=5, id_lt="e561de8f-00f1-11e4-b400-0cc47a024be0")
# Create a new activityactivity_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 activityactivity_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 iduser_feed_1.remove_activity("e561de8f-00f1-11e4-b400-0cc47a024be0")
# or by foreign iduser_feed_1.remove_activity(foreign_id='tweet:1')
# Follow another feeduser_feed_1.follow('flat', '42')
# Stop following another feeduser_feed_1.unfollow('flat', '42')
# List followers/followingfollowing=user_feed_1.following(offset=0, limit=2)
followers=user_feed_1.followers(offset=0, limit=10)
# Creates many follow relationships in one requestfollows= [
{'source': 'flat:1', 'target': 'user:1'},
{'source': 'flat:1', 'target': 'user:2'},
{'source': 'flat:1', 'target': 'user:3'}
]
client.follow_many(follows)
# Batch adding activitiesactivities= [
{'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` fieldactivity= {
"actor":"1",
"verb":"like",
"object":"3",
"to":["user:44", "user:45"]
}
user_feed_1.add_activity(activity)
# Retrieve an activity by its IDclient.get_activities(ids=[activity_id])
# Retrieve an activity by the combination of foreign_id and timeclient.get_activities(foreign_id_times=[
(foreign_id, activity_time),
])
# Enrich while getting activitiesclient.get_activities(ids=[activity_id], enrich=True, reactions={"counts": True})
# Update some parts of an activity with activity_partial_updateset= {
'product.name': 'boots',
'colors': {
'red': '0xFF0000',
'green': '0x00FF00'
}
}
unset= [ 'popularity', 'details.info' ]
# ...by IDclient.activity_partial_update(id=activity_id, set=set, unset=unset)
# ...or by combination of foreign_id and timeclient.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 clicksimpression= {
'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)importdatetimeimportstreamclient=stream.connect('YOUR_API_KEY', 'API_KEY_SECRET', use_async=True)
# Create a new client specifying data center locationclient=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 objectuser_feed_1=client.feed('user', '1')
# Get activities from 5 to 10 (slow pagination)result=awaituser_feed_1.get(limit=5, offset=5)
# (Recommended & faster) Filter on an id less than the given UUIDresult=awaituser_feed_1.get(limit=5, id_lt="e561de8f-00f1-11e4-b400-0cc47a024be0")
# Create a new activityactivity_data= {'actor': 1, 'verb': 'tweet', 'object': 1, 'foreign_id': 'tweet:1'}
activity_response=awaituser_feed_1.add_activity(activity_data)
# Create a bit more complex activityactivity_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()
}
awaituser_feed_1.add_activity(activity_data)
# Remove an activity by its idawaituser_feed_1.remove_activity("e561de8f-00f1-11e4-b400-0cc47a024be0")
# or by foreign idawaituser_feed_1.remove_activity(foreign_id='tweet:1')
# Follow another feedawaituser_feed_1.follow('flat', '42')
# Stop following another feedawaituser_feed_1.unfollow('flat', '42')
# List followers/followingfollowing=awaituser_feed_1.following(offset=0, limit=2)
followers=awaituser_feed_1.followers(offset=0, limit=10)
# Creates many follow relationships in one requestfollows= [
{'source': 'flat:1', 'target': 'user:1'},
{'source': 'flat:1', 'target': 'user:2'},
{'source': 'flat:1', 'target': 'user:3'}
]
awaitclient.follow_many(follows)
# Batch adding activitiesactivities= [
{'actor': 1, 'verb': 'tweet', 'object': 1},
{'actor': 2, 'verb': 'watch', 'object': 3}
]
awaituser_feed_1.add_activities(activities)
# Add an activity and push it to other feeds too using the `to` fieldactivity= {
"actor":"1",
"verb":"like",
"object":"3",
"to":["user:44", "user:45"]
}
awaituser_feed_1.add_activity(activity)
# Retrieve an activity by its IDawaitclient.get_activities(ids=[activity_id])
# Retrieve an activity by the combination of foreign_id and timeawaitclient.get_activities(foreign_id_times=[
(foreign_id, activity_time),
])
# Enrich while getting activitiesawaitclient.get_activities(ids=[activity_id], enrich=True, reactions={"counts": True})
# Update some parts of an activity with activity_partial_updateset= {
'product.name': 'boots',
'colors': {
'red': '0xFF0000',
'green': '0x00FF00'
}
}
unset= [ 'popularity', 'details.info' ]
# ...by IDawaitclient.activity_partial_update(id=activity_id, set=set, unset=unset)
# ...or by combination of foreign_id and timeawaitclient.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 clicksimpression= {
'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)=======
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) first. See our license file for more details.
We've recently closed a $38 million Series B funding round 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.