This repository has been archived by the owner on Oct 9, 2018. It is now read-only.
forked from hotsyk/python-odesk
-
Notifications
You must be signed in to change notification settings - Fork 8
/
README.html
174 lines (164 loc) · 8.67 KB
/
README.html
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
<!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>Python bindings to oDesk API — 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.6',
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="python-odesk 0.5.6 documentation" href="index.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="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">python-odesk 0.5.6 documentation</a> »</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="#">Python bindings to oDesk API</a><ul>
<li><a class="reference internal" href="#requirements">Requirements</a></li>
<li><a class="reference internal" href="#installation">Installation</a></li>
<li><a class="reference internal" href="#ssl-certificates-note">SSL Certificates Note</a></li>
<li><a class="reference internal" href="#quickstart">Quickstart</a></li>
<li><a class="reference internal" href="#useful-links">Useful Links</a></li>
</ul>
</li>
</ul>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="sources/README.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="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<a class="reference external image-reference" href="http://www.apache.org/licenses/LICENSE-2.0.html"><img alt="License" src="http://img.shields.io/packagist/l/odesk/php-odesk.svg" /></a>
<a class="reference external image-reference" href="http://badge.fury.io/py/python-odesk"><img alt="PyPI version" src="https://badge.fury.io/py/python-odesk.svg" /></a>
<p>Copyright (c) 2010-2014, oDesk <a class="reference external" href="http://www.odesk.com">http://www.odesk.com</a>
All rights reserved.</p>
<div class="section" id="python-bindings-to-odesk-api">
<h1>Python bindings to oDesk API<a class="headerlink" href="#python-bindings-to-odesk-api" title="Permalink to this headline">¶</a></h1>
<p>This is a Python bindings for Public oDesk API <a class="reference external" href="https://developers.odesk.com/">https://developers.odesk.com/</a>
Using the API you can build apps that will help you:</p>
<ul class="simple">
<li>Mangage your distributed team</li>
<li>Search for contractors and jobs</li>
<li>Send bulk invitations to interview and make offers</li>
<li>Send bulk messages to your team</li>
<li>Retrieve Time & Financial information for your company, team and contractors</li>
</ul>
<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==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>
<blockquote>
<div>pip install python-odesk</div></blockquote>
<p>All the dependencies will be automatically installed as well.</p>
</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>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’s certificates file.</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">'HTTPLIB_CA_CERTS_PATH'</span><span class="p">]</span> <span class="o">=</span> <span class="s">'/path/to/my/ca_certs.txt'</span>
</pre></div>
</div>
</div>
<div class="section" id="quickstart">
<h2>Quickstart<a class="headerlink" href="#quickstart" title="Permalink to this headline">¶</a></h2>
<p>First, you need to create API key for authorization here:
<a class="reference external" href="https://www.odesk.com/services/api/keys">https://www.odesk.com/services/api/keys</a></p>
<p>Installing <strong>Ipython</strong> interactive shell is very useful for playing
with the API, it has autocomplete, history, displays docstring help if you add ‘?’
to the end of variable/function/class/method and many other nice things.
So we greatly encourage you to install it: <tt class="docutils literal"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">ipython</span></tt></p>
<p>To get started, look at the docs <a class="reference external" href="http://odesk.github.io/python-odesk/how_to.html">http://odesk.github.io/python-odesk/how_to.html</a>
and also look at the <tt class="docutils literal"><span class="pre">examples/</span></tt> folder to see examples how to
obtain oauth access tokens for web application and desktop application.</p>
<p>Also threre’s a list of opensource projects using <tt class="docutils literal"><span class="pre">python-odesk</span></tt>:</p>
<ul class="simple">
<li>oDesk Meter <a class="reference external" href="https://github.com/kipanshi/odesk_meter">https://github.com/kipanshi/odesk_meter</a></li>
<li>oDesk Graphs <a class="reference external" href="https://github.com/demalexx/odesk-graphs">https://github.com/demalexx/odesk-graphs</a></li>
</ul>
</div>
<div class="section" id="useful-links">
<h2>Useful Links<a class="headerlink" href="#useful-links" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><a class="reference external" href="http://github.com/odesk/python-odesk">Git repo</a></li>
<li><a class="reference external" href="http://github.com/odesk/python-odesk/issues">Issues</a></li>
<li><a class="reference external" href="http://odesk.github.com/python-odesk/">Documentation</a></li>
<li><a class="reference external" href="http://groups.google.com/group/python-odesk">Mailing list</a></li>
<li><a class="reference external" href="http://www.facebook.com/group.php?gid=136364403050710">Facebook group</a></li>
</ul>
</div>
</div>
</div>
</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="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">python-odesk 0.5.6 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2010-2013, odesk.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
</html>