Skip to content
This repository

Python wrapper for Behance API

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 behance_python
Octocat-spinner-32 .gitignore
Octocat-spinner-32 CHANGES.txt
Octocat-spinner-32 LICENSE
Octocat-spinner-32 MANIFEST
Octocat-spinner-32 README.md
Octocat-spinner-32 requirements.txt
Octocat-spinner-32 setup.py
README.md

behance_python

A Python wrapper for the Behance API

Warning! This wrapper is very much still in development and could change substantially!

Note that this library does not currently support any of the OAUTH based POST functionality. This functionality will be added in future releases.

Please see Behance API documentation to get an API key and more information, including field names and example content.

Note: Many Behance API endpoints provide data in pages of 12 items. You will need to page through results until you receive a 500 error (in the form of a BehanceException) which will indicate that there are no more pages.

Installation

pip install behance_python

Or:

git clone git://github.com/aravenel/behance_python.git

Usage

All wrapper functionality flows from the main API object which must be instantiated using your Behance-provided API Key.

All attributes can be accessed using either objects (object.key) or dict (object['key']) notation. Beware! Some of the JSON returned may have numerical keys, which Python cannot use for object notation--you will need to access these by their dict notation. Additionally, as JSON returns unicode, integer keys have been converted from unicode to ints to make life easier.

API Object Usage

from behance_python.api import API

behance = API('your_api_key_here')

Project functionality

Search for projects

projects = behance.project_search('term1', 'term2', filter_key='filter_value')
projects[0].owners[129052].first_name
>>> 'Matias'

Supports all filters and modifiers as supported by Behance.

Data will be returned as list of objects with same keys as Behance API. To save on API calls, these are not full Project objects (i.e. they do not have all of the attributes you would get from get_project())--you must call the API.get_project(project_id) method to get project details including images.

Get Single Project Details

proj = behance.get_project(project_id)
project_images = [module.src for module in proj.modules if module.type=='image']
len(project_images)
>>> 3

Returns an instance of the Project object. This object has attributes named identically to attributes as returned by Behance API. As with the API, artwork associated with a project are stored in Project.modules, which is a list of objects, each object representing one module and its corresponding metadata.

Get Project Comments

comments = proj.get_comments()
comment[0].user.first_name
>>> 'Matias'

Method of the Project object. Returns list of objects, each object representing a single comment and its metadata.

User functionality

Search for Users

users = behance.user_search('term1', 'term2', filter_key='filter_value')
users[0].first_name
>>> 'Matias'

Works just like project_search.

Get Single User Details

user = behance.get_user(user_id_or_username)
user.first_name
>>> 'Matias'

Returns User object. This object has attributes named identically to attributes as returned by Behance API.

Get User Projects

user_projects = user.get_projects(filter_key='filter_value')
user_projects[0].name 
>>> 'The ALVA Award'

Method of the User object. Returns list of objects. Can optionally include any filters supported by Behance API. So as not to chew up API calls, these are not actual Project objects. To get artwork associated with these projects, you will need to call the API.get_project(project_id) method.

Get User Works in Progress

user_wips = user.get_wips(filter_key='filter_value')
wips[0].latest_rev_id
>>> '173'

Method of the User object. Returns list of objects. Can optionally include any filters supported by Behance API. So as not to chew up API calls, these are not actual WIP objects. To get artwork associated with these projects, you will need to call the API.get_WIP(wip_id) method.

Get User Appreciations

user_appreciations = user.get_appreciations(filter_key='filter_value')
user_appreciations[0].project.id
>>> 4979439

Method of the User object. Can optionally include any filters supported by Behance API. Returns list of objects.

Get User Collections

user_collections = user.get_collections(filter_key='filter_value')
user_collections[0].title
>>> '00 Curation'

Method of the User object. Can optionally include any filters supported by Behance API. Returns list of objects.

Get User Stats

user_stats = user.get_stats()
user_stats.today.project_views
>>> 220

Method of the User object.

Get User Followers

followers = user.get_followers(filter_key='filter_value')
followers[0].username
>>> 'getflourish'

Method of the User object. Can optionally include any filters supported by Behance API. Returns list of objects.

Get Users Being Followed

following = user.get_following(filter_key='filter_value')
following[0].username
>>> 'getflourish'

Method of the User object. Can optionally include any filters supported by Behance API. Returns list of objects.

Get User Feedback Circle

feedback_circle = user.get_feedback()
feedback[0].username
>>> 'getflourish'

Method of the User object. Returns list of objects.

Get Work Experience

work_experience = user.get_work_experience()
work_experience[0].position
>>> 'Senior Designer'

Method of the User object. Returns list of objects.

Work in Progress Functionality

Search for Works in Progress

wips = behance.wip_search('term1', 'term2', filter_key='filter_value')
wips[0].title
>>> 'Restaurant Menu Cover'

Works just like project_search.

Get Work in Progress

wip = behance.get_wip(wip_id)
wip.title
>>> 'Portfolio Review Schedule Design'

Returns WIP object. This object has attributes named identically to attributes as returned by Behance API.

Get Revision

rev = wip.get_revision(revision_id)
rev.tags
>>> ['behance', 'schedule', 'information']

Works in progress store multiple revisions. Fetch individidual revisions with a revision ID. Method of the WIP object.

Get Comments

comments = wip.get_revision_comments(revision_id, filter_key='filter_value')
comments[0].user.first_name
>>> 'Matias'

Comments are stored associated with a revision. Method of the WIP object. Can optionally include any filters supported by Behance API. Returns list of objects.

Collection Functionality

Search for Collections

collections = behance.collection_search('term1', 'term2', filter_key='filter_value')
collections[0].title
>>> "Candy Landia"

Works just like project_search.

Get Collection

collection = behance.get_collection(collection_id)
collection.title
>>> 'Cool Candy Related Projects.'

Returns Collection object. This object has attributes named identically to attributes as returned by Behance API.

Get Collection Projects

projects = collection.get_projects(filter_key='filter_value')
projects[0].name
>>> 'Sweets'

Returns list of projects that are members of a collection. Note that these are not actual Project instances to save on API calls--to get artwork for these, you would need to call API.get_project(project_id). Can optionally include any filters supported by Behance API.

Exceptions

Unfortunately, they happen. If an exception happens in the calling of the API but before a response is returned (e.g. a timeout), the library will raise the exception from the underlying Requests library. If the response from the Behance API is anything other than status code 200, it will raise an exception corresponding to the error code. These exceptions are all subclasses of the BehanceException, and they are:

  • Forbidden (403 error)
  • NotFound (404 error)
  • TooManyRequests (423 error)
  • InternalServerError (500 error)
  • ServiceUnavailable (503 error)

If any other error code is received, will throw a generic BehanceException with the actual error code stored in attribute self.error_code.

Something went wrong with that request. Please try again.