aboutsummaryrefslogtreecommitdiffstats
path: root/python/migration.md
diff options
context:
space:
mode:
authorDevendra2014-06-18 01:02:15 +0530
committerDevendra2014-06-18 01:02:15 +0530
commita1ee7f8bd90b463318bfa75f7ee4f58d458d2a24 (patch)
tree9e260902f960f792a93fa25e3b619c42ecb5f4d4 /python/migration.md
parentbfd5c64bdf7ed45f21207cb53c653e7220e39eff (diff)
parent083127cde127dd78fc88ffe2b3b82144b2c07038 (diff)
downloadpubnub-python-a1ee7f8bd90b463318bfa75f7ee4f58d458d2a24.tar.bz2
Merge branch 'master' into develop
Diffstat (limited to 'python/migration.md')
-rw-r--r--python/migration.md205
1 files changed, 205 insertions, 0 deletions
diff --git a/python/migration.md b/python/migration.md
new file mode 100644
index 0000000..61cf203
--- /dev/null
+++ b/python/migration.md
@@ -0,0 +1,205 @@
+## Contact support@pubnub.com for all questions
+
+#### [PubNub](http://www.pubnub.com) Real-time Data Network
+##### Standalone Python Migration
+
+#### Init
+
+```
+
+# Pre 3.5:
+pubnub = Pubnub(
+ "demo", ## PUBLISH_KEY
+ "demo", ## SUBSCRIBE_KEY
+ False ## SSL_ON?
+)
+
+# New in 3.5+
+pubnub = Pubnub(publish_key="demo", subscribe_key="demo", ssl_on=False)
+
+```
+
+#### PUBLISH
+
+```
+channel = 'hello_world'
+message = 'Hello World !!!'
+
+# Pre 3.5:
+info = pubnub.publish({
+ 'channel' : channel,
+ 'message' : message
+})
+print(info)
+
+# New in 3.5+
+
+# Synchronous usage
+print pubnub.publish(channel='hello_world', message='Hello World !!!')
+
+# Asynchronous usage
+
+def callback(message):
+ print(message)
+
+pubnub.publish(channel, message, callback=callback, error=callback)
+
+```
+
+
+#### SUBSCRIBE
+Pre 3.5.x, subscribe was blocking and would only be terminated via a false return from the callback. In our latest version of the SDK, subscribe is asyncronous, and because of this, usage is a bit different, but the experience is more like our other async SDKs.
+
+```
+
+# Listen for Messages
+
+channel = 'hello_world'
+
+# Pre 3.5:
+# Listen for Messages *BLOCKING*
+def receive(message) :
+ print(message)
+ return True
+
+pubnub.subscribe({
+ 'channel' : channel,
+ 'callback' : receive
+})
+
+
+# New in 3.5+
+
+def callback(message, channel):
+ print(message)
+
+
+def error(message):
+ print("ERROR : " + str(message))
+
+
+def connect(message):
+ print("CONNECTED")
+
+
+def reconnect(message):
+ print("RECONNECTED")
+
+
+def disconnect(message):
+ print("DISCONNECTED")
+
+
+pubnub.subscribe(channel, callback=callback, error=callback,
+ connect=connect, reconnect=reconnect, disconnect=disconnect)
+```
+
+#### Unsubscribe
+Once subscribed, you can easily, gracefully, unsubscribe:
+
+```
+# Pre 3.5:
+#
+
+# New in 3.5+
+
+pubnub.unsubscribe(channel='hello_world')
+```
+
+#### PRESENCE
+
+```
+
+
+channel = 'hello_world'
+
+# Pre 3.5:
+def pres_event(message) :
+ print(message)
+ return True
+
+pubnub.presence({
+ 'channel' : channel,
+ 'callback' : receive
+})
+
+
+# New in 3.5+
+
+# Listen for Presence Event Messages
+
+def callback(message, channel):
+ print(message)
+
+
+def error(message):
+ print("ERROR : " + str(message))
+
+
+
+pubnub.presence(channel, callback=callback, error=callback)
+```
+
+#### HERE_NOW
+
+```
+
+# Pre 3.5:
+# Get info on who is here right now!
+
+here_now = pubnub.here_now({
+ 'channel' : 'hello_world',
+})
+
+print(here_now['occupancy'])
+print(here_now['uuids'])
+
+
+# New in 3.5+
+
+# Get info on who is here right now!
+
+channel = 'hello_world'
+
+# Synchronous usage
+print pubnub.here_now(channel)
+
+
+# Asynchronous usage
+
+def callback(message):
+ print(message)
+
+pubnub.here_now(channel, callback=callback, error=callback)
+```
+
+#### HISTORY
+
+```
+
+# Pre 3.5:
+# Load Previously Published Messages
+history = pubnub.detailedHistory({
+ 'channel' : 'my_channel',
+ 'end' : my_end_time_token, # Optional
+ 'start' : my_start_time_token, # Optional
+ 'count' : num_of_msgs_to_return # Optional, default is 100
+})
+print(history)
+
+# New in 3.5+
+
+# Synchronous usage
+
+print pubnub.history(channel, count=2)
+
+# Asynchronous usage
+
+
+def callback(message):
+ print(message)
+
+pubnub.history(channel, count=2, callback=callback, error=callback)
+```
+
+## Contact support@pubnub.com for all questions