mirror of
https://github.com/frappe/frappe_docker.git
synced 2026-06-21 15:25:09 +00:00
171 lines
5.2 KiB
Text
171 lines
5.2 KiB
Text
Metadata-Version: 2.0
|
|
Name: dropbox
|
|
Version: 7.3.1
|
|
Summary: Official Dropbox API Client
|
|
Home-page: http://www.dropbox.com/developers
|
|
Author: Dropbox
|
|
Author-email: dev-platform@dropbox.com
|
|
License: MIT License
|
|
Platform: UNKNOWN
|
|
Classifier: Development Status :: 4 - Beta
|
|
Classifier: Intended Audience :: Developers
|
|
Classifier: License :: OSI Approved :: MIT License
|
|
Classifier: Operating System :: OS Independent
|
|
Classifier: Programming Language :: Python
|
|
Classifier: Programming Language :: Python :: 2.7
|
|
Classifier: Programming Language :: Python :: 3.3
|
|
Classifier: Programming Language :: Python :: 3.4
|
|
Classifier: Programming Language :: Python :: 3.5
|
|
Classifier: Programming Language :: Python :: 3.6
|
|
Classifier: Programming Language :: Python :: Implementation :: CPython
|
|
Classifier: Programming Language :: Python :: Implementation :: PyPy
|
|
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
Requires-Dist: requests (>=2.5.1,!=2.6.1)
|
|
Requires-Dist: six (>=1.3.0)
|
|
Requires-Dist: urllib3
|
|
|
|
Dropbox for Python
|
|
==================
|
|
|
|
.. image:: https://travis-ci.org/dropbox/dropbox-sdk-python.svg?branch=v7.3.0
|
|
:target: https://travis-ci.org/dropbox/dropbox-sdk-python
|
|
|
|
.. image:: https://readthedocs.org/projects/dropbox-sdk-python/badge/?version=stable
|
|
:target: https://dropbox-sdk-python.readthedocs.org/en/stable/
|
|
:alt: [Latest Release Documentation]
|
|
|
|
.. image:: https://img.shields.io/pypi/v/dropbox.svg
|
|
:target: https://pypi.python.org/pypi/dropbox
|
|
:alt: [Latest Release Version]
|
|
|
|
.. image:: https://img.shields.io/pypi/l/dropbox.svg
|
|
:target: http://opensource.org/licenses/MIT
|
|
:alt: [Latest Release License]
|
|
|
|
.. image:: https://img.shields.io/pypi/pyversions/dropbox.svg
|
|
:target: https://pypi.python.org/pypi/dropbox
|
|
:alt: [Latest Release Supported Python Versions]
|
|
|
|
.. image:: https://img.shields.io/pypi/implementation/dropbox.svg
|
|
:target: https://pypi.python.org/pypi/dropbox
|
|
:alt: [Latest Release Supported Python Implementations]
|
|
|
|
.. image:: https://img.shields.io/pypi/status/dropbox.svg
|
|
:target: https://pypi.python.org/pypi/dropbox
|
|
:alt: [Latest Release Development Stage]
|
|
|
|
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
|
|
<http://dropbox-sdk-python.readthedocs.org/>`_.
|
|
|
|
Installation
|
|
------------
|
|
|
|
Install via ``pip``:
|
|
|
|
.. code-block:: console
|
|
|
|
$ pip install dropbox
|
|
|
|
Install from source:
|
|
|
|
.. code-block:: console
|
|
|
|
$ 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:
|
|
|
|
.. code-block:: pycon
|
|
|
|
>>> import dropbox
|
|
>>> dbx = dropbox.Dropbox("YOUR_ACCESS_TOKEN")
|
|
>>> dbx.users_get_current_account()
|
|
|
|
Creating an Application
|
|
-----------------------
|
|
|
|
You need to create an Dropbox Application to make API requests.
|
|
|
|
- Go to https://dropbox.com/developers/apps.
|
|
|
|
Obtaining an Access Token
|
|
-------------------------
|
|
|
|
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.
|
|
|
|
Examples
|
|
--------
|
|
|
|
``example/updown.py`` demonstrates how to sync a local directory with a Dropbox.
|
|
|
|
Documentation
|
|
-------------
|
|
|
|
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`_.
|
|
|
|
Updating API specification
|
|
--------------------------
|
|
|
|
A good amount of this SDK is generated using `Stone
|
|
<https://www.github.com/dropbox/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
|
|
<https://www.github.com/dropbox/dropbox-api-spec>`_.
|
|
|
|
To prepare the repo for generation, run these commands after cloning:
|
|
|
|
.. code-block:: console
|
|
|
|
$ 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:
|
|
|
|
.. code-block:: console
|
|
|
|
$ ./generate_base_client.py
|
|
|
|
Upgrading from v1
|
|
-----------------
|
|
|
|
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.
|
|
|
|
Testing
|
|
-------
|
|
|
|
We use the `tox <https://tox.readthedocs.org/>`_ package to run tests in Python
|
|
2 and 3. To install, use :code:`pip install tox`. Once installed, run `tox` from the
|
|
root directory. You'll need to specify a working Dropbox OAuth2 token:
|
|
|
|
.. code-block:: console
|
|
|
|
$ DROPBOX_TOKEN=YOUR_TOKEN tox -- -k "'not test_team'"
|
|
|
|
Note that we skip ``test_team`` which requires a team token with `Member File Access
|
|
<https://www.dropbox.com/developers/documentation/http/teams#teams-member-file-access>`_.
|
|
To test this functionality, specify a ``DROPBOX_TEAM_TOKEN`` environment
|
|
variable.
|
|
|
|
.. code-block:: console
|
|
|
|
$ DROPBOX_TOKEN=... DROPBOX_TEAM_TOKEN=... tox
|
|
|
|
If you only want to test the API v2 client, use:
|
|
|
|
.. code-block:: console
|
|
|
|
$ DROPBOX_TOKEN=... DROPBOX_TEAM_TOKEN=... tox -- -k TestDropbox
|
|
|
|
|