aboutsummaryrefslogtreecommitdiffstats
path: root/python/README.md
diff options
context:
space:
mode:
authorgcohen2014-02-05 18:03:32 -0800
committergcohen2014-02-05 18:03:32 -0800
commit082296d67beff28db323ffb3479861eaef3d0d50 (patch)
tree800511f421c191bcbe107352217ca82f831b1774 /python/README.md
parent1d601e3411af27c1b39e697849a538b692a535e7 (diff)
downloadpubnub-python-082296d67beff28db323ffb3479861eaef3d0d50.tar.bz2
filerename
Diffstat (limited to 'python/README.md')
-rw-r--r--python/README.md123
1 files changed, 123 insertions, 0 deletions
diff --git a/python/README.md b/python/README.md
new file mode 100644
index 0000000..ba65e53
--- /dev/null
+++ b/python/README.md
@@ -0,0 +1,123 @@
+## ---------------------------------------------------
+##
+## YOU MUST HAVE A PUBNUB ACCOUNT TO USE THE API.
+## http://www.pubnub.com/account
+##
+## ----------------------------------------------------
+
+## --------------------------------------------------
+## PubNub 3.3 Web Data Push Cloud-hosted API - PYTHON
+## --------------------------------------------------
+##
+## www.pubnub.com - PubNub Web Data Push Service in the Cloud.
+## http://github.com/pubnub/pubnub-api/tree/master/python
+##
+## PubNub is a Massively Scalable Data Push Service for Web and Mobile Games.
+## This is a cloud-based service for broadcasting messages
+## to thousands of web and mobile clients simultaneously.
+
+## ---------------
+## Python Push API
+## ---------------
+
+### Check out additional tests and examples in the 3.2 directory!
+
+pubnub = Pubnub(
+ "demo", ## PUBLISH_KEY
+ "demo", ## SUBSCRIBE_KEY
+ None, ## SECRET_KEY
+ False ## SSL_ON?
+)
+
+# -------
+# PUBLISH
+# -------
+# Send Message
+info = pubnub.publish({
+ 'channel' : 'hello_world',
+ 'message' : {
+ 'some_text' : 'Hello my World'
+ }
+})
+print(info)
+
+# ---------
+# SUBSCRIBE
+# ---------
+# Listen for Messages *BLOCKING*
+def receive(message) :
+ print(message)
+ return True
+
+pubnub.subscribe({
+ 'channel' : 'hello_world',
+ 'callback' : receive
+})
+
+# ---------
+# PRESENCE
+# ---------
+# Listen for Presence Event Messages *BLOCKING*
+
+def pres_event(message) :
+ print(message)
+ return True
+
+pubnub.presence({
+ 'channel' : 'hello_world',
+ 'callback' : receive
+})
+
+# ---------
+# HERE_NOW
+# ---------
+# Get info on who is here right now!
+
+here_now = pubnub.here_now({
+ 'channel' : 'hello_world',
+})
+
+print(here_now['occupancy'])
+print(here_now['uuids'])
+
+
+# ------------------
+## Channel Analytics
+# ------------------
+analytics = pubnub.analytics({
+ 'channel' : 'channel-name-here', ## Leave blank for all channels
+ 'limit' : 100, ## aggregation range
+ 'ago' : 0, ## minutes ago to look backward
+ 'duration' : 100 ## minutes offset
+})
+print(analytics)
+
+# -------
+# HISTORY
+# -------
+# Load Previously Published Messages
+history = pubnub.history({
+ 'channel' : 'hello_world',
+ 'limit' : 1
+})
+print(history)
+
+
+# -------
+# DETAILED HISTORY
+# -------
+# Load Previously Published Messages in Detail
+ @param array args with 'channel', optional: 'start', 'end', 'reverse', 'count'
+ 'channel'-Channel name
+ 'start'-Start timestamp
+ 'end'-End timestamp
+ 'reverse'-Order of History
+ 'count'-Number of History messages
+
+ NSInteger count = 3;
+ NSNumber * aCountInt = [NSNumber numberWithInteger:count];
+ [pubnub detailedHistory:[NSDictionary dictionaryWithObjectsAndKeys:
+ aCountInt,@"count",
+ @"hello_world",@"channel",
+ nil]];
+