Skip to content

Latest commit

 

History

History
118 lines (70 loc) · 3.04 KB

getting_started.rst

File metadata and controls

118 lines (70 loc) · 3.04 KB

Getting started

Requirements

You need to install oauth2 and urllib3 to run the python-odesk. These packages are installed automatically, so basicly you don't need to install them manually.

If you want to contribute to python-odesk, you need to istall mock and nosetests.

Mock:

pip install mock
#or
easy_install mock

Nosetests:

pip install nose
#or
easy_install nose

Install

On most UNIX-like systems, you’ll probably need to run these commands as root or using sudo.

To install via pip:

pip install python-odesk

Or via easy_install:

easy_install python-odesk

Or install from source:

python setup.py install

Also, you can retrieve the most recent version of python-odesk from GitHub:

git clone git://github.com/odesk/python-odesk.git

Settings

You will need to use your public and private oDesk API keys:

client = odesk.Client('your public key', 'your secret key')

To get oDesk API keys, please visit the http://www.odesk.com/services/api/keys

Simple Example

This example is very easy to follow in Python interactive console, we also recommend to use improved interactive console - IPython.

You can see the full code of examples in odesk/examples folder.

Here is the simple example if you are using web API keys.

Initializing the client:

client = odesk.Client(public_key, secret_key)

Now follow the authorize_url:

print client.auth.get_authorize_url()

After you follow this url you'll be redirected to the callback url that you entered during API keys creation. The oauth_verifier parameter is passed to the callback and you need to copy it's value. If you selected "Desktop" type of the key instead of "Web", the value of oAuth verifier will be just displayed to you.

Now you get the verifier copied into your buffer and you can get you access token:

verifier = raw_input('Enter oauth_verifier: ')
oauth_access_token, oauth_access_token_secret = client.auth.get_access_token(verifier)

Great! Now you got all the necessary credentials for accessing the oDesk API. Use obtained oauth_access_token and oauth_access_token_secret to intialize a ready-to-go Client instance:

client = odesk.Client(public_key, secret_key,
                      oauth_access_token=oauth_access_token,
                      oauth_access_token_secret=oauth_access_token_secret)

To check it works:

print client.auth.get_info()

This call will give you information about the currently authorized user.

Note

Make sure you securely store the oauth_access_token and oauth_access_token_secret.

So now just start playing with the API, for example you can get your teamrooms:

print client.team.get_teamrooms()

or get your companies:

print client.hr.get_companies()

See the Reference Documentation for the full list of available API calls :ref:`reference_docs`