update docs

tbarbugli · tbarbugli · commit 9e2ce164dd3f · 2018-11-30T15:38:37.000+01:00
diff --git a/README.md b/README.md
@@ -28,6 +28,8 @@ Documentation for this Python client are available at the [Stream website](https
 ### Usage
 
 ```python
+import datetime
+
 # Instantiate a new client
 import stream
 client = stream.connect('YOUR_API_KEY', 'API_KEY_SECRET')
@@ -116,15 +118,11 @@ 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 tokens for client side usage (JS client)
-token = user_feed_1.token
-# Javascript client side feed initialization
-# user1 = client.feed('user', '1', '{{ token }}');
+# Generating user token for client side usage (JS client)
+user_token = client.create_user_token("user-42")
 
-# Generate a read-only token for client side usage (JS client)
-readonly_token = user_feed_1.get_readonly_token()
 # Javascript client side feed initialization
-# user1 = client.feed('user', '1', '{{ readonly_token }}');
+# client = stream.connect(apiKey, userToken, appId);
 
 # Generate a redirect url for the Stream Analytics platform to track
 # events/impressions on url clicks
@@ -164,6 +162,15 @@ py.test --cov stream --cov-report html
 LOCAL=true py.test
 ```
 
+Install black and flake8
+
+```
+pip install black
+pip install flake8
+```
+
+Install git hooks to avoid pushing invalid code (git commit will run black and flak8)
+
 ### Releasing a new version
 
 In order to release new version you need to be a maintainer on Pypi.
diff --git a/stream/client.py b/stream/client.py
@@ -168,7 +168,7 @@ def _parse_response(self, response):
             self.raise_exception(parsed_result, status_code=response.status_code)
         return parsed_result
 
-    def create_user_session_token(self, user_id, **extra_data):
+    def create_user_token(self, user_id, **extra_data):
         """Setup the payload for the given user_id with optional
         extra data (key, value pairs) and encode it using jwt
         """
@@ -177,6 +177,9 @@ def create_user_session_token(self, user_id, **extra_data):
             payload[k] = v
         return jwt.encode(payload, self.api_secret, algorithm="HS256").decode("utf-8")
 
+    def create_user_session_token(self, user_id, **extra_data):
+        return self.create_user_token(user_id, **extra_data)
+
     def create_jwt_token(self, resource, action, feed_id=None, user_id=None):
         """
         Setup the payload for the given resource, action, feed or user
