Official Freelancer.com API SDK
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
examples Add search projects projections Jul 2, 2018
freelancersdk Merge pull request #45 from gabrnavarro/gnavarro-add-request-id-messages Feb 2, 2019
tests Merge pull request #45 from gabrnavarro/gnavarro-add-request-id-messages Feb 2, 2019
.gitignore 0.1.1 public release Oct 28, 2015
.travis.yml fix failing build Apr 6, 2018
COPYING.LESSER Update Dec 18, 2017
LICENSE Update Dec 18, 2017
MANIFEST.in Add MANIFEST.in Dec 18, 2017
PYPI_DESCRIPTION.rst Fix PYPI description Dec 18, 2017
README.rst edit readme, typo Apr 19, 2018
RELEASE.md Document explaining how to make a new release Apr 6, 2018
TODO Update Dec 18, 2017
setup.cfg Bump version; add separate file for PYPI description; Fix example Dec 18, 2017
setup.py Bump release to 0.1.20 Feb 7, 2019
tox.ini Update Dec 18, 2017

README.rst

Python library for Freelancer.com API

https://travis-ci.org/freelancer/freelancer-sdk-python.svg?branch=master

This is a Python library for the Freelancer.com API. Using this, you can interact with Freelancer.com from your Python applications. It supports Python 2.7 and Python 3 (3.6+). For more about information about the Freelancer.com API, visit https://developers.freelancer.com.

Install

Install it using pip install freelancersdk. It may be a good idea to use virtualenv as part of your workflow.

Versioning

The current version series of the library is 0.1.x which corresponds to the 0.1 version of the API. The revision number x corresponds to the revision of the SDK. The 0.1 series of the library will continue to support (in a backward compatible way) the 0.1 version of the Freelancer.com API.

Usage

The first step to using any SDK function is to create a Session object:

>>> from freelancersdk.session import Session
>>> session = Session(oauth_token=token)

You must have a valid OAuth2 token before you can use the SDK or the API. See the Freelancer.com Developer portal for more information on how you can do so.

Once we have a session object, we can start using the SDK functions.

Examples

All the examples below recognizes two environment variables:

  • FLN_OAUTH_TOKEN: The OAuth2 token to create the session with and must be specified
  • FLN_URL: If you want to use the library to make requests against the Freelancer.com Sandbox, you can specifiy FLN_URL=https://www.freelancer-sandbox.com. If not specified, it defaults to https://www.freelancer.com.

Projects

Bids

Milestone Payments

Messaging

Contests

Users

License

GNU LGPLv3. Please see LICENSE and COPYING.LESSER.

Please note that 0.1.3 release changed the LICENSE from BSD to GNU LGPLv3. If you were using the library prior to this release, please file a issue to let us know if the change affects you in any way.