Note
Every method is fully documented in the docstring, so you can refer to the :ref:`reference_docs` or directly view help in the interactive console.
To get help on the method use:
help(client.provider.search_jobs)
or if you use IPython just add ? symbol at the end of an object/class/method:
client.provider.search_jobs?
https://developers.odesk.com/?lang=python#authentication
To authenticate your web application with the python-odesk, use something similar to the code below:
public_key = raw_input('Please enter public key: > ')
secret_key = raw_input('Please enter secret key: > ')
#Instantiating a client without an auth token
client = odesk.Client(public_key, secret_key)
print "Please to this URL (authorize the app if necessary):"
print client.auth.get_authorize_url()
print "After that you should be redirected back to your app URL with " + \
"additional ?oauth_verifier= parameter"
verifier = raw_input('Enter oauth_verifier: ')
oauth_access_token, oauth_access_token_secret = \
client.auth.get_access_token(verifier)
# Instantiating a new client, now with a token.
# Not strictly necessary here (could just set `client.oauth_access_token`
# and `client.oauth_access_token_secret`), but typical for web apps,
# which wouldn't probably keep client instances between requests
client = odesk.Client(public_key, secret_key,
oauth_access_token=oauth_access_token,
oauth_access_token_secret=oauth_access_token_secret)
https://developers.odesk.com/?lang=python#public-profiles_get-brief-profile-summary https://developers.odesk.com/?lang=python#public-profiles_get-profile-details
.. currentmodule:: odesk.routers.provider.Provider
To get information about freelancer, use following methods (click the link to see detailed description of parameters):
:py:meth:`client.provider.get_provider<get_provider>`
:py:meth:`client.provider.get_provider_brief<get_provider_brief>`
.. currentmodule:: odesk.routers.provider.Provider_V2
To search for a freelancer (https://developers.odesk.com/?lang=python#public-profiles_search-for-freelancers) by the query string, use:
:py:meth:`client.provider_v2.search_providers<search_providers>`
To search jobs(https://developers.odesk.com/?lang=python#jobs_search-for-jobs) by the query string, use:
:py:meth:`client.provider_v2.search_jobs<search_jobs>`
.. currentmodule:: odesk.routers.provider.Provider
To get information about available categories, skills, regions and tests use:
:py:meth:`client.provider.get_categories_metadata<get_categories_metadata>`
:py:meth:`client.provider.get_skills_metadata<get_skills_metadata>`
:py:meth:`client.provider.get_regions_metadata<get_regions_metadata>`
:py:meth:`client.provider.get_tests_metadata<get_tests_metadata>`
.. currentmodule:: odesk.routers.hr.HR
oDesk Hiring API https://developers.odesk.com/?lang=python#contracts-and-offers allows to do such tasks as:
- Create new job posting :py:meth:`client.hr.post_job<post_job>`
- Update existing job post :py:meth:`client.hr.update_job<update_job>`
- Work with milestones for fixed priced jobs: see https://developers.odesk.com/?lang=python#contracts-and-offers_milestones
- View existing jobs :py:meth:`client.hr.get_jobs<get_jobs>`
.. currentmodule:: odesk.routers.hr.HR_V1
- Invite to interview :py:meth:`client.hr_v1.invite_to_interview<invite_to_interview>`
.. currentmodule:: odesk.routers.hr.HR
- Make an offer :py:meth:`client.hr.post_offer<post_offer>`
- View active engagements :py:meth:`client.hr.get_engagements<get_engagements>`
- Pay a bonus to the contractor :py:meth:`client.hr.post_team_adjustment<post_team_adjustment>`
- End the contract with freelancer :py:meth:`client.hr.end_contract<end_contract>`
https://developers.odesk.com/?lang=python#jobs_get-job-profile
.. currentmodule:: odesk.routers.job
To work with jobs you should use :py:class:`client.job<Job>` wrapper:
tasks = client.job.get_job_profile(job key)
Where:
- job_key - The job key or a list of keys, separated by
";", number of keys per request is limited by 20. You can access profile by job reference number, in that case you can't specify a list of jobs, only one profile per request is available.
https://developers.odesk.com/?lang=python#companies-and-teams
.. currentmodule:: odesk.routers.team.Team_V2
After authentication, you can get teams' information from client instance you have:
:py:meth:`client.team_v2.get_teamrooms<get_teamrooms>`
To get snapshots:
:py:meth:`client.team_v2.get_snapshots<get_snapshots>`
.. currentmodule:: odesk.routers.team.Team
To get user's workdiaries inside the team:
:py:meth:`client.team.get_workdiaries<get_workdiaries>`
https://developers.odesk.com/?lang=python#messages
.. currentmodule:: odesk.routers.mc.MC
Get user's trays (if user not provided, authenticated user will be taken):
:py:meth:`client.mc.get_trays<get_trays>`
Get content of the tray:
:py:meth:`client.mc.get_tray_content<get_tray_content>`
Get content of the thread:
:py:meth:`client.mc.get_thread_content<get_thread_content>`
https://developers.odesk.com/?lang=python#messages_send-message
To send message:
:py:meth:`client.mc.post_message<post_message>`
.. currentmodule:: odesk.routers.timereport.TimeReport
https://developers.odesk.com/?lang=python#reports_time-reports-fields
To get timereports, use, based on the level of the timereports you need:
:py:meth:`client.timereport.get_provider_report<get_provider_report>`
:py:meth:`timereport.get_company_report<get_agency_report>`
:py:meth:`timereport.get_agency_report<get_agency_report>`
Below is an example how to construct a GDS query:
client.timereport.get_provider_report('user1',
odesk.utils.Query(select=odesk.utils.Query.DEFAULT_TIMEREPORT_FIELDS,
where=(odesk.utils.Q('worked_on') <= date.today()) &\
(odesk.utils.Q('worked_on') > '2010-05-01')))
client.timereport.get_provider_report('user1',
odesk.utils.Query(select=odesk.utils.Query.DEFAULT_TIMEREPORT_FIELDS,
where=(odesk.utils.Q('worked_on') <= date.today()) &\
(odesk.utils.Q('worked_on') > '2010-05-01')), hours=True)
client.timereport.get_agency_report('company1', 'agency1',
odesk.utils.Query(select=odesk.utils.Query.DEFAULT_TIMEREPORT_FIELDS,
where=(odesk.utils.Q('worked_on') <= date.today()) &\
(odesk.utils.Q('worked_on') > '2010-05-01')), hours=True)
.. currentmodule:: odesk.routers.finreport
https://developers.odesk.com/?lang=python#reports_financial-reports-fields
Financial reports are also using GDS queries.
Please see :py:class:`Finreports` wrapper
https://developers.odesk.com/?lang=python#activities
.. currentmodule:: odesk.routers.task
To work with Activities you should use :py:class:`client.task<Task>` wrapper:
tasks = client.task.get_team_tasks('your_company_id', 'your_team_id')
Note, that company_id here is basically a parent_team__id value
from the hr.get_team() API call.
.. currentmodule:: odesk.routers.task.Task
Methods to get activities:
:py:meth:`client.task.get_team_tasks<get_team_tasks>`
:py:meth:`client.task.get_company_tasks<get_company_tasks>`
:py:meth:`client.task.get_team_specific_tasks<get_team_specific_tasks>`
:py:meth:`client.task.get_company_specific_tasks<get_company_specific_tasks>`
Create and update activities:
:py:meth:`client.task.post_team_task<post_team_task>`
:py:meth:`client.task.post_company_task<post_company_task>`
:py:meth:`client.task.put_team_task<put_team_task>`
:py:meth:`client.task.put_company_task<put_company_task>`
Archive/unarchive activities:
:py:meth:`client.task.archive_team_task<archive_team_task>`
:py:meth:`client.task.archive_company_task<archive_company_task>`
:py:meth:`client.task.unarchive_team_task<unarchive_team_task>`
:py:meth:`client.task.unarchive_company_task<unarchive_company_task>`
Assign activities to the contractor's engagement: