Skip to main content

Official Box Python SDK

Project description

box-python-sdk
==============

.. image:: http://opensource.box.com/badges/active.svg
:target: http://opensource.box.com/badges

.. image:: https://travis-ci.org/box/box-python-sdk.png?branch=master
:target: https://travis-ci.org/box/box-python-sdk

.. image:: https://pypip.in/v/boxsdk/badge.png
:target: https://pypi.python.org/pypi/boxsdk

.. image:: https://pypip.in/d/boxsdk/badge.png
:target: https://pypi.python.org/pypi/boxsdk


Installing
----------

.. code-block:: console

pip install boxsdk


Authorization
-------------

The Box API uses OAuth2 for auth. The SDK makes it relatively painless to work with OAuth2 tokens.

Get the authorization url
~~~~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: python

from boxsdk.auth.oauth2 import OAuth2

oauth = OAuth2(
client_id='YOUR_CLIENT_ID',
client_secret='YOUR_CLIENT_SECRET',
store_tokens=your_store_tokens_callback_method,
)

auth_url, csrf_token = oauth.get_authorization_url('http://YOUR_REDIRECT_URL')

store_tokens is a callback used to store the access token
and refresh token. You might want to define something like this:

.. code-block:: python

def store_tokens(access_token, refresh_token):
# store the tokens at secure storage (e.g. Keychain)

The SDK will keep the tokens in memory for the duration of the Python script run, so you don't always need to
pass store_tokens.

Authenticate (get access/refresh token)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you navigate the user to the auth_url,
the user will eventually get redirected to
http://YOUR_REDIRECT_URL?code=YOUR_AUTH_CODE.
After getting the code, you will be able to use the code to exchange for access token and fresh token.

The SDK handles all the work for you; all you need to do is run:

.. code-block:: python

# Make sure that the csrf token you get from the `state` parameter in the final redirect URI is the same token you get from the get_authorization_url method.
assert 'THE_CSRF_TOKEN_YOU_GOT' == csrf_token
access_token, refresh_token = oauth.authenticate('YOUR_AUTH_CODE')

Create an authenticated client
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: python

from boxsdk.client import Client

client = Client(oauth)

And that's it! You can start using the client to do all kinds of cool stuff
and the SDK will handle the token refresh for you automatically.

Usage
-----

Get user info
~~~~~~~~~~~~~

.. code-block:: python

me = client.user(user_id='me').get()
print 'user_login: ' + me['login']

Get folder info
~~~~~~~~~~~~~~~

.. code-block:: python

root_folder = client.folder(folder_id='0').get()
print 'folder owner: ' + root_folder.owned_by['login']

Get items in a folder
~~~~~~~~~~~~~~~~~~~~~

.. code-block:: python

items = client.folder(folder_id='0').get_items(limit=100, offset=0)

Create subfolder
~~~~~~~~~~~~~~~~

.. code-block:: python

# creates folder structure /l1/l2/l3
client.folder(folder_id='0').create_subfolder('l1').create_subfolder('l2').create_subfolder('l3')

Get shared link
~~~~~~~~~~~~~~~

.. code-block:: python

shared_link = client.folder(folder_id='SOME_FOLDER_ID').get_shared_link()

Rename an item
~~~~~~~~~~~~~~

.. code-block:: python

client.file(file_id='SOME_FILE_ID').rename('bar-2.txt')

Get content of a file
~~~~~~~~~~~~~~~~~~~~~

.. code-block:: python

client.file(file_id='SOME_FILE_ID').content()

Lock/unlock a file
~~~~~~~~~~~~~~~~~~

.. code-block:: python

client.file(file_id='SOME_FILE_ID').lock()
client.file(file_id='SOME_FILE_ID').unlock()

Search
~~~~~~

.. code-block:: python

client.search('some_query', limit=100, offset=0)

Events
~~~~~~

.. code-block:: python

# Get events
client.events().get_events(limit=100, stream_position='now')

# Generate events using long polling
for event in client.events().generate_events_with_long_polling():
pass # Do something with the event

# Get latest stream position
client.events().get_latest_stream_position()


Contributing
------------

See `CONTRIBUTING <https://github.com/box/box-python-sdk/blob/master/CONTRIBUTING.rst>`_.


Developer Setup
~~~~~~~~~~~~~~~

Create a virtual environment and install packages -

.. code-block:: console

mkvirtualenv boxsdk
pip install -r requirements-dev.txt


Testing
~~~~~~~

Run all tests using -

.. code-block:: console

tox

The tox tests include code style checks via pep8 and pylint.

The tox tests are configured to run on Python 2.6, 2.7, 3.3, 3.4, and PyPy.


Copyright and License
---------------------

::

Copyright 2015 Box, Inc. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for boxsdk, version 1.0.1
Filename, size File type Python version Upload date Hashes
Filename, size boxsdk-1.0.1.tar.gz (54.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page