Skip to content
This repository has been archived by the owner on Oct 9, 2018. It is now read-only.

Commit

Permalink
Update docs to version 0.5.6
Browse files Browse the repository at this point in the history
  • Loading branch information
@kipanshi
kipanshi committed Feb 12, 2015
1 parent 4a92e77 commit 62cc4d1
Show file tree
Hide file tree
Showing 21 changed files with 222 additions and 141 deletions.
30 changes: 14 additions & 16 deletions README.html
View file
Expand Up @@ -6,15 +6,15 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Python bindings to oDesk API &mdash; python-odesk 0.5.5 documentation</title>
<title>Python bindings to oDesk API &mdash; python-odesk 0.5.6 documentation</title>

<link rel="stylesheet" href="static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="static/pygments.css" type="text/css" />

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.5.5',
VERSION: '0.5.6',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand All @@ -23,7 +23,7 @@
<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="python-odesk 0.5.5 documentation" href="index.html" />
<link rel="top" title="python-odesk 0.5.6 documentation" href="index.html" />
</head>
<body>
<div class="related">
Expand All @@ -35,7 +35,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">python-odesk 0.5.5 documentation</a> &raquo;</li>
<li><a href="index.html">python-odesk 0.5.6 documentation</a> &raquo;</li>
</ul>
</div>
<div class="sphinxsidebar">
Expand Down Expand Up @@ -96,9 +96,10 @@ <h1>Python bindings to oDesk API<a class="headerlink" href="#python-bindings-to-
<p>API is the best way to comunicate between apps.</p>
<div class="section" id="requirements">
<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline"></a></h2>
<p>httplib2&gt;=0.8
oauth2&gt;=1.5.211
urllib3&gt;=1.7</p>
<p>httplib2==0.9
oauth2==1.5.211
urllib3==1.10
httplib2.system-ca-certs-locater==0.1.1</p>
</div>
<div class="section" id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h2>
Expand All @@ -108,18 +109,15 @@ <h2>Installation<a class="headerlink" href="#installation" title="Permalink to t
</div>
<div class="section" id="ssl-certificates-note">
<h2>SSL Certificates Note<a class="headerlink" href="#ssl-certificates-note" title="Permalink to this headline"></a></h2>
<p>Unfortunately SSL certificates for oDesk are not included in the <tt class="docutils literal"><span class="pre">httplib==0.8</span></tt>.</p>
<p>Threrefore if you use Debian/Ubuntu/Archlinux,
we recomend to install a package <tt class="docutils literal"><span class="pre">httplib2.system_ca_certs_locater</span></tt>:</p>
<p>We recomend to install a package <tt class="docutils literal"><span class="pre">httplib2.system_ca_certs_locater</span></tt> (it is installed by default during <tt class="docutils literal"><span class="pre">python_odesk</span></tt> installation):</p>
<div class="highlight-python"><div class="highlight"><pre>pip install pbr httplib2.system_ca_certs_locater
</pre></div>
</div>
<p>It will force <tt class="docutils literal"><span class="pre">httplib2</span></tt> to use the OS&#8217;s certificates file.</p>
<p>Another option is to create a <tt class="docutils literal"><span class="pre">ca_certs_locater.py</span></tt> in your projects directory
and following the example from <a class="reference external" href="https://github.com/dreamhost/httplib2-ca_certs_locater">https://github.com/dreamhost/httplib2-ca_certs_locater</a>
load patched <tt class="docutils literal"><span class="pre">ca_certs.txt</span></tt> file.</p>
<p>You can find patched <tt class="docutils literal"><span class="pre">ca_certs.txt</span></tt> here:
<a class="reference external" href="https://github.com/kipanshi/odesk_meter/blob/master/lib/httplib2/cacerts.txt">https://github.com/kipanshi/odesk_meter/blob/master/lib/httplib2/cacerts.txt</a></p>
<p>If you want to use your own certificates, put the following code during initialization:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s">&#39;HTTPLIB_CA_CERTS_PATH&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s">&#39;/path/to/my/ca_certs.txt&#39;</span>
</pre></div>
</div>
</div>
<div class="section" id="quickstart">
<h2>Quickstart<a class="headerlink" href="#quickstart" title="Permalink to this headline"></a></h2>
Expand Down Expand Up @@ -165,7 +163,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">python-odesk 0.5.5 documentation</a> &raquo;</li>
<li><a href="index.html">python-odesk 0.5.6 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
Expand Down
54 changes: 38 additions & 16 deletions changelog.html
View file
Expand Up @@ -6,15 +6,15 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Changelog &mdash; python-odesk 0.5.5 documentation</title>
<title>Changelog &mdash; python-odesk 0.5.6 documentation</title>

<link rel="stylesheet" href="static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="static/pygments.css" type="text/css" />

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.5.5',
VERSION: '0.5.6',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand All @@ -23,7 +23,7 @@
<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="python-odesk 0.5.5 documentation" href="index.html" />
<link rel="top" title="python-odesk 0.5.6 documentation" href="index.html" />
<link rel="next" title="BSD license" href="license.html" />
<link rel="prev" title="odesk.routers package" href="reference-docs/odesk.routers.html" />
</head>
Expand All @@ -43,14 +43,16 @@ <h3>Navigation</h3>
<li class="right" >
<a href="reference-docs/odesk.routers.html" title="odesk.routers package"
accesskey="P">previous</a> |</li>
<li><a href="index.html">python-odesk 0.5.5 documentation</a> &raquo;</li>
<li><a href="index.html">python-odesk 0.5.6 documentation</a> &raquo;</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Changelog</a><ul>
<li><a class="reference internal" href="#version-0-5-6">Version 0.5.6</a></li>
<li><a class="reference internal" href="#version-0-5-5-1">Version 0.5.5.1</a></li>
<li><a class="reference internal" href="#version-0-5-5">Version 0.5.5</a></li>
<li><a class="reference internal" href="#version-0-5-4">Version 0.5.4</a></li>
<li><a class="reference internal" href="#version-0-5-3">Version 0.5.3</a></li>
Expand Down Expand Up @@ -100,8 +102,28 @@ <h3>Quick search</h3>

<div class="section" id="changelog">
<span id="id1"></span><h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this headline"></a></h1>
<div class="section" id="version-0-5-6">
<span id="id2"></span><h2>Version 0.5.6<a class="headerlink" href="#version-0-5-6" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li>Added new API call - <a class="reference internal" href="reference-docs/odesk.routers.html#odesk.routers.provider.Provider_V2.get_categories_metadata" title="odesk.routers.provider.Provider_V2.get_categories_metadata"><tt class="xref py py-meth docutils literal"><span class="pre">List</span> <span class="pre">categories</span> <span class="pre">(v2)</span></tt></a>.</li>
<li>Added new API call - <a class="reference internal" href="reference-docs/odesk.routers.html#odesk.routers.team.Team_V2.get_workdiaries_by_contract" title="odesk.routers.team.Team_V2.get_workdiaries_by_contract"><tt class="xref py py-meth docutils literal"><span class="pre">Get</span> <span class="pre">Work</span> <span class="pre">Diary</span> <span class="pre">by</span> <span class="pre">Contract</span></tt></a>.</li>
<li>Recent changes from API Changelog - Wednesday, 2015-01-12</li>
<li>Recent changes from API Changelog - Wednesday, 2014-12-03</li>
<li>Recent changes from API Changelog - Friday, 2014-11-21</li>
<li>Recent changes from API Changelog - Friday, 2014-10-31</li>
</ul>
</div>
<div class="section" id="version-0-5-5-1">
<span id="id3"></span><h2>Version 0.5.5.1<a class="headerlink" href="#version-0-5-5-1" title="Permalink to this headline"></a></h2>
<p>Minor maintenance release:</p>
<ul class="simple">
<li>Updated urllib3 requirements to <a href="#id4"><span class="problematic" id="id5">``</span></a>urllib3==1.10`</li>
<li>Use fixed requirements in the <tt class="docutils literal"><span class="pre">setup.py</span></tt></li>
<li>Add <tt class="docutils literal"><span class="pre">httplib.system-ca-certs-locater</span></tt> and update Readme</li>
</ul>
</div>
<div class="section" id="version-0-5-5">
<span id="id2"></span><h2>Version 0.5.5<a class="headerlink" href="#version-0-5-5" title="Permalink to this headline"></a></h2>
<span id="id6"></span><h2>Version 0.5.5<a class="headerlink" href="#version-0-5-5" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li>Added new API call - <a class="reference internal" href="reference-docs/odesk.routers.html#odesk.routers.hr.HR_V3.create_milestone" title="odesk.routers.hr.HR_V3.create_milestone"><tt class="xref py py-meth docutils literal"><span class="pre">Create</span> <span class="pre">a</span> <span class="pre">new</span> <span class="pre">Milestone</span></tt></a>.</li>
<li>Added new API call - <a class="reference internal" href="reference-docs/odesk.routers.html#odesk.routers.hr.HR_V3.edit_milestone" title="odesk.routers.hr.HR_V3.edit_milestone"><tt class="xref py py-meth docutils literal"><span class="pre">Edit</span> <span class="pre">the</span> <span class="pre">Milestone</span></tt></a>.</li>
Expand All @@ -118,15 +140,15 @@ <h3>Quick search</h3>
</ul>
</div>
<div class="section" id="version-0-5-4">
<span id="id3"></span><h2>Version 0.5.4<a class="headerlink" href="#version-0-5-4" title="Permalink to this headline"></a></h2>
<span id="id7"></span><h2>Version 0.5.4<a class="headerlink" href="#version-0-5-4" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li>Added new API call - <a class="reference internal" href="reference-docs/odesk.routers.html#odesk.routers.hr.HR.suspend_contract" title="odesk.routers.hr.HR.suspend_contract"><tt class="xref py py-meth docutils literal"><span class="pre">Suspend</span> <span class="pre">Contract</span></tt></a>.</li>
<li>Added new API call - <a class="reference internal" href="reference-docs/odesk.routers.html#odesk.routers.hr.HR.restart_contract" title="odesk.routers.hr.HR.restart_contract"><tt class="xref py py-meth docutils literal"><span class="pre">Restart</span> <span class="pre">Contract</span></tt></a>.</li>
<li><a class="reference internal" href="reference-docs/odesk.routers.html#odesk.routers.task.Task.archive_team_task" title="odesk.routers.task.Task.archive_team_task"><tt class="xref py py-meth docutils literal"><span class="pre">Archive</span></tt></a>/<a class="reference internal" href="reference-docs/odesk.routers.html#odesk.routers.task.Task.unarchive_team_task" title="odesk.routers.task.Task.unarchive_team_task"><tt class="xref py py-meth docutils literal"><span class="pre">unarchive</span></tt></a> activities calls now support a list of codes.</li>
</ul>
</div>
<div class="section" id="version-0-5-3">
<span id="id4"></span><h2>Version 0.5.3<a class="headerlink" href="#version-0-5-3" title="Permalink to this headline"></a></h2>
<span id="id8"></span><h2>Version 0.5.3<a class="headerlink" href="#version-0-5-3" title="Permalink to this headline"></a></h2>
<ul>
<li><dl class="first docutils">
<dt>New API calls added:</dt>
Expand All @@ -145,7 +167,7 @@ <h3>Quick search</h3>
</ul>
</div>
<div class="section" id="version-0-5-2">
<span id="id5"></span><h2>Version 0.5.2<a class="headerlink" href="#version-0-5-2" title="Permalink to this headline"></a></h2>
<span id="id9"></span><h2>Version 0.5.2<a class="headerlink" href="#version-0-5-2" title="Permalink to this headline"></a></h2>
<ul>
<li><p class="first">Fixed engagements API call, so that you can call
<tt class="docutils literal"><span class="pre">client.hr.get_engagements()</span></tt> without any parameter
Expand Down Expand Up @@ -182,14 +204,14 @@ <h3>Quick search</h3>
</ul>
</div>
<div class="section" id="version-0-5-1">
<span id="id6"></span><h2>Version 0.5.1<a class="headerlink" href="#version-0-5-1" title="Permalink to this headline"></a></h2>
<span id="id10"></span><h2>Version 0.5.1<a class="headerlink" href="#version-0-5-1" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li>Fixed bug preventing update (<tt class="docutils literal"><span class="pre">PUT</span></tt> method) for oTask codes that
contained non-urlsafe characters, e.g. &#8220;space&#8221;, &#8220;colon&#8221;, etc.</li>
</ul>
</div>
<div class="section" id="version-0-5">
<span id="id7"></span><h2>Version 0.5<a class="headerlink" href="#version-0-5" title="Permalink to this headline"></a></h2>
<span id="id11"></span><h2>Version 0.5<a class="headerlink" href="#version-0-5" title="Permalink to this headline"></a></h2>
<p><em>October 2013</em></p>
<p>Backwards incompatibility changes:</p>
<ul class="simple">
Expand Down Expand Up @@ -222,7 +244,7 @@ <h3>Quick search</h3>
</ul>
</div>
<div class="section" id="version-0-4">
<span id="id8"></span><h2>Version 0.4<a class="headerlink" href="#version-0-4" title="Permalink to this headline"></a></h2>
<span id="id12"></span><h2>Version 0.4<a class="headerlink" href="#version-0-4" title="Permalink to this headline"></a></h2>
<p><em>May 2011</em></p>
<ul class="simple">
<li><em>Incompatibility with previous release</em> Changed name of the otask router to the task</li>
Expand All @@ -239,15 +261,15 @@ <h3>Quick search</h3>
</ul>
</div>
<div class="section" id="version-0-2">
<span id="id9"></span><h2>Version 0.2<a class="headerlink" href="#version-0-2" title="Permalink to this headline"></a></h2>
<span id="id13"></span><h2>Version 0.2<a class="headerlink" href="#version-0-2" title="Permalink to this headline"></a></h2>
<p><em>October 2010</em></p>
<ul class="simple">
<li>All helpers classes moved to the utils.py, added Table helper class</li>
<li><em>Incompatibility with previous release</em> Changed names of the methods&#8217; params to reflect real oDesk params - e.g. company_reference vs company name</li>
</ul>
</div>
<div class="section" id="version-0-1-2">
<span id="id10"></span><h2>Version 0.1.2<a class="headerlink" href="#version-0-1-2" title="Permalink to this headline"></a></h2>
<span id="id14"></span><h2>Version 0.1.2<a class="headerlink" href="#version-0-1-2" title="Permalink to this headline"></a></h2>
<p><em>29 September 2010</em></p>
<p>Bug fix release</p>
<ul class="simple">
Expand All @@ -256,7 +278,7 @@ <h3>Quick search</h3>
</ul>
</div>
<div class="section" id="version-0-1-1">
<span id="id11"></span><h2>Version 0.1.1<a class="headerlink" href="#version-0-1-1" title="Permalink to this headline"></a></h2>
<span id="id15"></span><h2>Version 0.1.1<a class="headerlink" href="#version-0-1-1" title="Permalink to this headline"></a></h2>
<p><em>15 July 2010</em></p>
<p>Bug fix release</p>
<ul class="simple">
Expand All @@ -265,7 +287,7 @@ <h3>Quick search</h3>
</ul>
</div>
<div class="section" id="version-0-1">
<span id="id12"></span><h2>Version 0.1<a class="headerlink" href="#version-0-1" title="Permalink to this headline"></a></h2>
<span id="id16"></span><h2>Version 0.1<a class="headerlink" href="#version-0-1" title="Permalink to this headline"></a></h2>
<p><em>08 July 2010</em></p>
<p>First public release</p>
</div>
Expand All @@ -292,7 +314,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="reference-docs/odesk.routers.html" title="odesk.routers package"
>previous</a> |</li>
<li><a href="index.html">python-odesk 0.5.5 documentation</a> &raquo;</li>
<li><a href="index.html">python-odesk 0.5.6 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
Expand Down
10 changes: 5 additions & 5 deletions docs_readme.html
View file
Expand Up @@ -6,15 +6,15 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Generating documentation &mdash; python-odesk 0.5.5 documentation</title>
<title>Generating documentation &mdash; python-odesk 0.5.6 documentation</title>

<link rel="stylesheet" href="static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="static/pygments.css" type="text/css" />

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.5.5',
VERSION: '0.5.6',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand All @@ -23,7 +23,7 @@
<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="python-odesk 0.5.5 documentation" href="index.html" />
<link rel="top" title="python-odesk 0.5.6 documentation" href="index.html" />
</head>
<body>
<div class="related">
Expand All @@ -35,7 +35,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">python-odesk 0.5.5 documentation</a> &raquo;</li>
<li><a href="index.html">python-odesk 0.5.6 documentation</a> &raquo;</li>
</ul>
</div>
<div class="sphinxsidebar">
Expand Down Expand Up @@ -119,7 +119,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">python-odesk 0.5.5 documentation</a> &raquo;</li>
<li><a href="index.html">python-odesk 0.5.6 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
Expand Down

0 comments on commit 62cc4d1

Please sign in to comment.