/usr/share/doc/python-pypump-doc/html/gettingstarted/tutorial.html is in python-pypump-doc 0.3+git20130823.1.97bffc6-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Tutorial — PyPump 1.0.0 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.0.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="PyPump 1.0.0 documentation" href="../index.html" />
<link rel="next" title="Authorization" href="authentication.html" />
<link rel="prev" title="Quick ‘n Dirty!" href="qnd.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="authentication.html" title="Authorization"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="qnd.html" title="Quick ‘n Dirty!"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">PyPump 1.0.0 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="tutorial">
<h1>Tutorial<a class="headerlink" href="#tutorial" title="Permalink to this headline">¶</a></h1>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This tutorial is prep for an API that does not yet actually exist... we’re doing the documentation driven development route. But this is what it should look like! ;)</p>
</div>
<div class="section" id="pypump-and-the-pump-api">
<h2>PyPump and the Pump API<a class="headerlink" href="#pypump-and-the-pump-api" title="Permalink to this headline">¶</a></h2>
<p>PyPump is aiming to implement and interface with the <a class="reference external" href="https://github.com/e14n/pump.io/blob/master/API.md">Pump API</a>, which is a
federation protocol for the web. You can read the actual Pump API
docs to get a sense of all that, but here’s a high level overview.</p>
<p>The Pump API is all about ActivityStreams and sending json-encoded
descriptions of activities back and forth across different users on
different sites. At the highest conceptual level, it’s not too
different from the idea of email servers sending emails back and
forth, but the messages (activities here) are much more specific and
carry more specific meaning about what “type” of message is being sent
back and forth. An activity can be a user “favoriting” something or
“posting an image” or what have you.</p>
<p>In the world of email, each user has an email address; in the world of
Pump, each user has a <a class="reference external" href="http://code.google.com/p/webfinger/">webfinger</a>
address. It looks pretty similar, but it’s meant for the web. For
the sake of this tutorial, you don’t need to know how webfinger works;
the PyPump API will handle that for you.</p>
<p>Each user has two main feeds that are used for communication. In the
Pump API docs’ own wording:</p>
<ul class="simple">
<li>An <strong>activity outbox</strong> (probably at /api/user/<nickname>/feed). This
is where the user posts new activities, and where others can read
the user’s activities.</li>
<li>An <strong>activity inbox</strong> (probably at /api/user/<nickname>/inbox). This is
where the user can read posts that were sent to him/her. Remote
servers can post activities here to be delivered to the user.</li>
</ul>
<p>(We use the inbox/outbox convention fairly strongly in PyPump.)</p>
<p>You should read the Pump spec, but sometimes coding examples are the
best way to learn. So, that said, let’s get into an example of using
PyPump!</p>
</div>
<div class="section" id="a-quick-example">
<h2>A quick example<a class="headerlink" href="#a-quick-example" title="Permalink to this headline">¶</a></h2>
<p>Let’s assume you already have a user with the webfinger id of
<a class="reference external" href="mailto:mizbunny%40example.org">mizbunny<span>@</span>example<span>.</span>org</a>. We want to check what our latest messages
are! But before we can do that, we need to authenticate. If this is
your first time, you need to authenticate this client:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">pypump</span> <span class="kn">import</span> <span class="n">PyPump</span>
<span class="gp">>>> </span><span class="n">pump</span> <span class="o">=</span> <span class="n">PyPump</span><span class="p">(</span><span class="s">"mizbunny@example.org"</span><span class="p">,</span> <span class="n">client_name</span><span class="o">=</span><span class="s">"Test.io"</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">client_credentials</span> <span class="o">=</span> <span class="n">pump</span><span class="o">.</span><span class="n">get_registration</span><span class="p">()</span>
<span class="go"># will return [<token>, <secret>]</span>
<span class="gp">>>> </span><span class="n">client_tokens</span> <span class="o">=</span> <span class="n">pump</span><span class="o">.</span><span class="n">get_token</span><span class="p">()</span>
</pre></div>
</div>
<p>The PyPump call will try to verify with OAuth, You may wish to override how it asks for authentication.
PyPump by default writes to standard out a URL for the user to click and reads in from standard in for a verification
code presented by the webserver.</p>
<p>You should store the client credentials somewhere. You can now
reconnect like so:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">pump</span> <span class="o">=</span> <span class="n">PyPump</span><span class="p">(</span>
<span class="gp">... </span> <span class="s">"mizbunny@example.org"</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">key</span><span class="o">=</span><span class="n">client_credentials</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="c"># the client key</span>
<span class="gp">... </span> <span class="n">secret</span><span class="o">=</span><span class="n">client_credentials</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="c"># the client secret</span>
<span class="gp">... </span> <span class="n">token</span><span class="o">=</span><span class="n">client_tokens</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="c"># the token key</span>
<span class="gp">... </span> <span class="n">token_secret</span><span class="o">=</span><span class="n">client_tokens</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="c"># the token secret</span>
<span class="gp">... </span> <span class="p">)</span>
</pre></div>
</div>
<p>Okay, we’re connected! Next up, we want to check out what our last 30
items in our inbox are, but first we need to find ourselves:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">me</span> <span class="o">=</span> <span class="n">pump</span><span class="o">.</span><span class="n">Person</span><span class="p">(</span><span class="s">"mizbunny@example.org"</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">me</span><span class="o">.</span><span class="n">summary</span>
<span class="gp">>>> </span><span class="s">'Hello and welcome to my summary'</span>
</pre></div>
</div>
<p>That looks like us, now to find our inbox items.
The inbox comes in three versions</p>
<ul class="simple">
<li>me.inbox.major is where major activities such as posted notes and images end up.</li>
<li>me.inbox.minor is where minor activities such as likes and comments end up.</li>
<li>me.inbox is a combination of both of the above.</li>
</ul>
<p>We only want to see notes, so we use the major inbox.
The inbox supports python-style index slicing:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">recent_activities</span> <span class="o">=</span> <span class="n">me</span><span class="o">.</span><span class="n">inbox</span><span class="o">.</span><span class="n">major</span><span class="p">[:</span><span class="mi">30</span><span class="p">]</span> <span class="c"># get last 30 activities</span>
</pre></div>
</div>
<p>We could print out each of the most recent activities like so:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="k">for</span> <span class="n">activity</span> <span class="ow">in</span> <span class="n">recent_activities</span><span class="p">:</span>
<span class="gp">>>> </span> <span class="k">print</span> <span class="n">activity</span>
<span class="go"><Activity: Evan Prodromou posted a note></span>
<span class="go"><Activity: jrobb posted a note></span>
<span class="go"><Activity: jpope posted a note></span>
<span class="go"><Activity: sazius posted a note></span>
<span class="gp">...</span>
</pre></div>
</div>
<p>Maybe we’re just looking at our most recent message, and see it’s from
our friend Evan. It seems that he wants to invite us over for a
dinner party:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">activity</span> <span class="o">=</span> <span class="n">recent_activities</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="gp">>>> </span><span class="n">activity</span>
<span class="go"><Activity: Evan Prodromou posted a note></span>
<span class="gp">>>> </span><span class="n">message</span> <span class="o">=</span> <span class="n">activity</span><span class="o">.</span><span class="n">obj</span>
<span class="gp">>>> </span><span class="n">message</span><span class="o">.</span><span class="n">author</span>
<span class="go"><User evan@e14n.com></span>
<span class="gp">>>> </span><span class="n">message</span><span class="o">.</span><span class="n">content</span>
<span class="go">"Yo, want to come over to dinner? We're making asparagus!"</span>
</pre></div>
</div>
<p>We can comment on the message saying we’d love to:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">our_reply</span> <span class="o">=</span> <span class="n">pump</span><span class="o">.</span><span class="n">Comment</span><span class="p">(</span><span class="s">"I'd love to!"</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">message</span><span class="o">.</span><span class="n">comment</span><span class="p">(</span><span class="n">our_reply</span><span class="p">)</span> <span class="c"># this is evans message we got above!</span>
</pre></div>
</div>
<p>(Since this Note activity is being instantiated, it needs a
reference to our PyPump class instance. Objects that you get back and
forth from the API themselves will try to keep track of their own
parent PyPump object for you.)</p>
<p>We could even like/favourite the previous message:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">message</span><span class="o">.</span><span class="n">like</span><span class="p">()</span>
</pre></div>
</div>
<p>We can also check to see what our buddy’s public feed is. Maybe
he’s said some interesting things?:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">evan</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">author</span>
<span class="gp">>>> </span><span class="k">for</span> <span class="n">activity</span> <span class="ow">in</span> <span class="n">evan</span><span class="o">.</span><span class="n">outbox</span><span class="p">:</span>
<span class="gp">>>> </span> <span class="n">message</span> <span class="o">=</span> <span class="n">activity</span><span class="o">.</span><span class="n">obj</span>
<span class="gp">>>> </span> <span class="k">print</span> <span class="n">message</span><span class="o">.</span><span class="n">content</span>
</pre></div>
</div>
<p>Prehaps we want to know a bit about Evan:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="k">print</span> <span class="n">evan</span><span class="o">.</span><span class="n">summary</span>
</pre></div>
</div>
<p>Want to see what the model actually looks like?
All activities in pump.io have a .seralize method:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="k">print</span> <span class="n">message</span><span class="o">.</span><span class="n">to_json</span><span class="p">(</span><span class="n">indent</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
<span class="go">{</span>
<span class="go">"id": "http://coding.example/api/activity/bwkflwken",</span>
<span class="go">"actor": {</span>
<span class="go"> "id": "acct:bwk@coding.example",</span>
<span class="go"> "objectType": "person",</span>
<span class="go"> "displayName": "Brian Kernighan"</span>
<span class="go">},</span>
<span class="go">"verb": "follow",</span>
<span class="go">"to": [{</span>
<span class="go"> "id": "acct:ken@coding.example",</span>
<span class="go"> "objectType": "person"</span>
<span class="go">}],</span>
<span class="go">"object": {</span>
<span class="go"> "id": "acct:ken@coding.example",</span>
<span class="go"> "objectType": "person",</span>
<span class="go"> "displayName": "Ken Thompson"</span>
<span class="go">},</span>
<span class="go">"published": "1974-01-01T00:00:00",</span>
<span class="go">"links": [</span>
<span class="go"> {"rel": "self", "href": "http://coding.example/api/activity/bwkflwken"}</span>
<span class="go">]</span>
<span class="go">}</span>
</pre></div>
</div>
<p>(The indent attribute here is passed to to give prettier output.)</p>
<p>(similarly, all activity classes provide a unserialize class method).</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Tutorial</a><ul>
<li><a class="reference internal" href="#pypump-and-the-pump-api">PyPump and the Pump API</a></li>
<li><a class="reference internal" href="#a-quick-example">A quick example</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="qnd.html"
title="previous chapter">Quick ‘n Dirty!</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="authentication.html"
title="next chapter">Authorization</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/gettingstarted/tutorial.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="authentication.html" title="Authorization"
>next</a> |</li>
<li class="right" >
<a href="qnd.html" title="Quick ‘n Dirty!"
>previous</a> |</li>
<li><a href="../index.html">PyPump 1.0.0 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2013, Jessica Tallon.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
|