A Python SDK for integrating with the Dropbox API v2. Compatible with Python 2.7 and 3.4+. Documentation is available on Read the Docs.
Install via pip
:
$ pip install dropbox
Install from source:
$ git clone git://github.com/dropbox/dropbox-sdk-python.git
$ cd dropbox-sdk-python
$ python setup.py install
After installation, to get started, open a Python console:
>>> import dropbox
>>> dbx = dropbox.Dropbox("YOUR_ACCESS_TOKEN")
>>> dbx.users_get_current_account()
You need to create an Dropbox Application to make API requests.
All requests need to be made with an OAuth 2 access token. To get started, once you've created an app, you can go to the app's console and generate an access token for your own Dropbox account.
example/updown.py
demonstrates how to sync a local directory with a Dropbox.
Documentation can be compiled by running make html
from the docs
folder. After compilation, open docs/_build/html/index.html
. Alternatively,
you can read a hosted version from Read the Docs.
A good amount of this SDK is generated using Stone. We use git submodules to pin to a specific version of Stone since it's under active development, and we also pin to a version of our API spec.
To prepare the repo for generation, run these commands after cloning:
$ git submodule init
$ git submodule update
You can run git pull
within these sub repositories to update the pinned
version.
Now, run the included script:
$ ./generate_base_client.py
To ease the transition to the new API and SDK, you can still use the old
dropbox.client.DropboxClient
class. In fact, v2 and v1 can be used
simultaneously. Support for the old client will be dropped once the new SDK is
at functional parity.
We use the tox package to run tests in Python
2 and 3. To install, use pip install tox
. Once installed, run tox from the
root directory. You'll need to specify a working Dropbox OAuth2 token:
$ DROPBOX_TOKEN=YOUR_TOKEN tox -- -k "'not test_team'"
Note that we skip test_team
which requires a team token with Member File Access.
To test this functionality, specify a DROPBOX_TEAM_TOKEN
environment
variable.
$ DROPBOX_TOKEN=... DROPBOX_TEAM_TOKEN=... tox
If you only want to test the API v2 client, use:
$ DROPBOX_TOKEN=... DROPBOX_TEAM_TOKEN=... tox -- -k TestDropbox