/usr/share/doc/python-pypump-doc/html/models/person.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 | <!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>Person — 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="Activity" href="activity.html" />
<link rel="prev" title="Comment" href="comment.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="activity.html" title="Activity"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="comment.html" title="Comment"
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="person">
<h1>Person<a class="headerlink" href="#person" title="Permalink to this headline">¶</a></h1>
<p>This object represents a user on pump.io.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The pump variable is an instantiated PyPump class e.g. pump = PyPump(“<webfinger>”, client_name=”<name>”, etc...)</p>
</div>
<dl class="class">
<dt id="Person">
<em class="property">class </em><tt class="descname">Person</tt><a class="headerlink" href="#Person" title="Permalink to this definition">¶</a></dt>
<dd><p>This represents a Person object, These are used in getting their inboxes, information on, etc...</p>
<dl class="attribute">
<dt id="Person.preferred_username">
<tt class="descname">preferred_username</tt><a class="headerlink" href="#Person.preferred_username" title="Permalink to this definition">¶</a></dt>
<dd><p>This is the username (you should display the display_name) (unicode):</p>
<div class="highlight-python"><pre> >>> a_person.preferred_username
u'Tsyesika'</pre>
</div>
</dd></dl>
<dl class="attribute">
<dt id="Person.display_name">
<tt class="descname">display_name</tt><a class="headerlink" href="#Person.display_name" title="Permalink to this definition">¶</a></dt>
<dd><p>This is the username you should display (unicode):</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">a_person</span><span class="o">.</span><span class="n">display_name</span>
<span class="go">u'Tsyesìka'</span>
</pre></div>
</div>
</dd></dl>
<dl class="attribute">
<dt id="Person.updated">
<tt class="descname">updated</tt><a class="headerlink" href="#Person.updated" title="Permalink to this definition">¶</a></dt>
<dd><p>This is when their profile was updated (datetime.datetime):</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">a_person</span><span class="o">.</span><span class="n">updated</span>
<span class="go"> datetime.datetime(2013, 6, 15, 12, 31, 22, 134180)</span>
</pre></div>
</div>
</dd></dl>
<dl class="attribute">
<dt id="Person.published">
<tt class="descname">published</tt><a class="headerlink" href="#Person.published" title="Permalink to this definition">¶</a></dt>
<dd><p>This is when their profile was first published (datetime.datetime):</p>
<div class="highlight-python"><pre> >>> a_person.published
datetime.datetime(2013, 6, 15, 12, 31, 22, 134180)</pre>
</div>
</dd></dl>
<dl class="attribute">
<dt id="Person.url">
<tt class="descname">url</tt><a class="headerlink" href="#Person.url" title="Permalink to this definition">¶</a></dt>
<dd><p>The URL to the profile (string):</p>
<div class="highlight-python"><pre> >>> a_person.url
'https://pump.megworld.co.uk/Tsyesika'</pre>
</div>
</dd></dl>
<dl class="attribute">
<dt id="Person.followers">
<tt class="descname">followers</tt><a class="headerlink" href="#Person.followers" title="Permalink to this definition">¶</a></dt>
<dd><p>This is a list of their followers (list):</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">a_person</span><span class="o">.</span><span class="n">followers</span>
<span class="go">[<Person: person1@yep.org>, <Person: person2@pumpit.com>, <Person: someoneelse@example.com></span>
</pre></div>
</div>
</dd></dl>
<dl class="attribute">
<dt id="Person.following">
<tt class="descname">following</tt><a class="headerlink" href="#Person.following" title="Permalink to this definition">¶</a></dt>
<dd><p>This is a list of all the people they’re following:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">a_person</span><span class="o">.</span><span class="n">following</span>
<span class="go">[<Person: TheBestPersonEvah@pump.megworld.co.uk>]</span>
</pre></div>
</div>
</dd></dl>
<dl class="attribute">
<dt id="Person.location">
<tt class="descname">location</tt><a class="headerlink" href="#Person.location" title="Permalink to this definition">¶</a></dt>
<dd><p>This is the location of the user (Location object):</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">a_person</span><span class="o">.</span><span class="n">location</span>
<span class="go"><Location: Manchester, UK></span>
</pre></div>
</div>
</dd></dl>
<dl class="attribute">
<dt id="Person.summary">
<tt class="descname">summary</tt><a class="headerlink" href="#Person.summary" title="Permalink to this definition">¶</a></dt>
<dd><p>This is the summer of the user (unicode):</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">a_person</span><span class="o">.</span><span class="n">summary</span>
<span class="go">u'The maker of this fabulous library!'</span>
</pre></div>
</div>
</dd></dl>
<dl class="attribute">
<dt id="Person.image">
<tt class="descname">image</tt><a class="headerlink" href="#Person.image" title="Permalink to this definition">¶</a></dt>
<dd><p>This is the image of the person (Image object):</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">a_person</span><span class="o">.</span><span class="n">image</span>
<span class="go"><Image: https://pump.megworld.co.uk/uploads/Tsyesika/2013/6/15/blahblah.png></span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="Person.follow">
<tt class="descname">follow</tt><big>(</big><big>)</big><a class="headerlink" href="#Person.follow" title="Permalink to this definition">¶</a></dt>
<dd><p>This will follow the user if you’re not already following them</p>
</dd></dl>
<dl class="method">
<dt id="Person.unfollow">
<tt class="descname">unfollow</tt><big>(</big><big>)</big><a class="headerlink" href="#Person.unfollow" title="Permalink to this definition">¶</a></dt>
<dd><p>This will stop following the user if you were following them</p>
</dd></dl>
</dd></dl>
<div class="section" id="example">
<h2>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2>
<p>This shows how to follow someone:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">a_person</span><span class="o">.</span><span class="n">follow</span><span class="p">()</span> <span class="c"># yay we're now following them!</span>
</pre></div>
</div>
<p>What happens when i try and follow someone I am?:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">a_person</span><span class="o">.</span><span class="n">follow</span><span class="p">()</span> <span class="c"># nothing? yep.</span>
</pre></div>
</div>
<p>Well, I don’t want to follow them:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">a_person</span><span class="o">.</span><span class="n">unfollow</span><span class="p">()</span> <span class="c"># awhh :(</span>
</pre></div>
</div>
<p>You want to find <a class="reference external" href="mailto:yourfriend%40pumpity.net">yourfriend<span>@</span>pumpity<span>.</span>net</a>:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">my_friend</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">"yourfriend@pumpity.net"</span><span class="p">)</span>
<span class="gt">Traceback (most recent call last):</span>
<span class="n">blah</span> <span class="n">blah</span>
<span class="n">you</span> <span class="n">know</span> <span class="n">the</span> <span class="n">drill</span>
<span class="gr">DoesNotExist</span>: <span class="n">Can't find yourfriend@pumpity.net</span>
</pre></div>
</div>
<p>Oh that’s right they’re on pump.megworld.co.uk:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">my_friend</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">"myfriend@pump.megworld.co.uk"</span><span class="p">)</span>
<span class="gp">>>> </span><span class="c"># Awesome!</span>
</pre></div>
</div>
</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="#">Person</a><ul>
<li><a class="reference internal" href="#example">Example</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="comment.html"
title="previous chapter">Comment</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="activity.html"
title="next chapter">Activity</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/models/person.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="activity.html" title="Activity"
>next</a> |</li>
<li class="right" >
<a href="comment.html" title="Comment"
>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>
|