Commit c9bfeead authored by Michael Fladischer's avatar Michael Fladischer

Update upstream source from tag 'upstream/9.0.0'

Update to upstream version '9.0.0'
with Debian dir 45c60f94af7ffa6e23b175b99e6f7a8998a0bd51
parents 69bf051b a1a31bc3
/.cache/
/.eggs/
/.idea/
/.tox/
/build/
/dist/
/docs/_build/
__pycache__/
.DS_Store
*.egg
*.egg-info/
*.pyc
*.pyo
*~
[submodule "stone"]
path = stone
url = https://github.com/dropbox/stone.git
[submodule "spec"]
path = spec
url = https://github.com/dropbox/dropbox-api-spec.git
[MESSAGES CONTROL]
disable=C,R,file-ignored,fixme,locally-disabled,protected-access,useless-else-on-loop
enable=useless-suppression
[REPORTS]
reports=n
language: python
python:
- "2.7"
- pypy
- "3.4"
- "3.5"
- pypy3
install:
- pip install tox-travis
matrix:
allow_failures:
# PyPy 3k probably won't work until it acquires compatibility with
# >= 3.4
- python: pypy3
script:
- tox
Metadata-Version: 1.1
Name: dropbox
Version: 8.7.1
Summary: Official Dropbox API Client
Home-page: http://www.dropbox.com/developers
Author: Dropbox
Author-email: dev-platform@dropbox.com
License: MIT License
Description: Dropbox for Python
==================
.. image:: https://travis-ci.org/dropbox/dropbox-sdk-python.svg?branch=v8.7.1
: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
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
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.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
Dropbox for Python
==================
.. image:: https://travis-ci.org/dropbox/dropbox-sdk-python.svg?branch=v8.7.1
.. image:: https://travis-ci.org/dropbox/dropbox-sdk-python.svg?branch=v9.0.0
:target: https://travis-ci.org/dropbox/dropbox-sdk-python
.. image:: https://readthedocs.org/projects/dropbox-sdk-python/badge/?version=stable
......
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
clean:
rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
# -*- coding: utf-8 -*-
#
# Dropbox for Python documentation build configuration file, created by
# sphinx-quickstart on Fri Oct 24 13:42:45 2014.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys
import os
# Assumes that the dropbox package to generate docs for is one-level above in
# the directory hierarchy. This takes precendence over other dropbox packages
# that may be in the sys.path.
sys.path.insert(0, os.path.abspath('..'))
import dropbox
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.mathjax',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'Dropbox for Python'
copyright = u'2015-2017, Dropbox, Inc.'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = dropbox.__version__
# The full version, including alpha/beta/rc tags.
release = dropbox.__version__
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#html_extra_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'DropboxforPythondoc'
# -- Options for LaTeX output ---------------------------------------------
#latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
#}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
#latex_documents = [
# ('index2', 'DropboxforPython.tex', u'Dropbox for Python Documentation',
# u'Ken Elkabany', 'manual'),
#]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
#man_pages = [
# ('index2', 'dropboxforpython', u'Dropbox for Python Documentation',
# [u'Dropbox, Inc.'], 1)
#]
# If true, show URL addresses after external links.
#man_show_urls = False
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
#texinfo_documents = [
# ('index2', 'DropboxforPython', u'Dropbox for Python Documentation',
# u'Dropbox, Inc.', 'DropboxforPython', 'One line description of project.',
# 'Miscellaneous'),
#]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
Dropbox for Python Documentation
================================
.. toctree::
:maxdepth: 2
tutorial
.. toctree::
:maxdepth: 2
moduledoc
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
@ECHO OFF
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set BUILDDIR=_build
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
set I18NSPHINXOPTS=%SPHINXOPTS% .
if NOT "%PAPER%" == "" (
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
)
if "%1" == "" goto help
if "%1" == "help" (
:help
echo.Please use `make ^<target^>` where ^<target^> is one of
echo. html to make standalone HTML files
goto end
)
if "%1" == "clean" (
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
del /q /s %BUILDDIR%\*
goto end
)
%SPHINXBUILD% 2> nul
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)
if "%1" == "html" (
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/html.
goto end
)
:end
*****************
SDK Documentation
*****************
:mod:`dropbox.async` -- Async
============================================
.. automodule:: dropbox.async
:members:
:show-inheritance:
:special-members: __init__
:undoc-members:
:mod:`dropbox.auth` -- Auth
============================================
.. automodule:: dropbox.auth
:members:
:show-inheritance:
:special-members: __init__
:undoc-members:
:mod:`dropbox.common` -- Common
============================================
.. automodule:: dropbox.common
:members:
:show-inheritance:
:special-members: __init__
:undoc-members:
:mod:`dropbox.dropbox` -- Dropbox
============================================
.. automodule:: dropbox.dropbox
:members:
:show-inheritance:
:inherited-members:
:special-members: __init__
:undoc-members:
:mod:`dropbox.exceptions` -- Exceptions
============================================
.. automodule:: dropbox.exceptions
:members:
:show-inheritance:
:special-members: __init__
:undoc-members:
:mod:`dropbox.file_properties` -- File Properties
============================================
.. automodule:: dropbox.file_properties
:members:
:show-inheritance:
:special-members: __init__
:undoc-members:
:mod:`dropbox.file_requests` -- File Requests
============================================
.. automodule:: dropbox.file_requests
:members:
:show-inheritance:
:special-members: __init__
:undoc-members:
:mod:`dropbox.files` -- Files
============================================
.. automodule:: dropbox.files
:members:
:show-inheritance:
:special-members: __init__
:undoc-members:
:mod:`dropbox.oauth` -- OAuth
============================================
.. automodule:: dropbox.oauth
:members:
:show-inheritance:
:special-members: __init__
:undoc-members:
:mod:`dropbox.paper` -- Paper
============================================
.. automodule:: dropbox.paper
:members:
:show-inheritance:
:special-members: __init__
:undoc-members:
:mod:`dropbox.seen_state` -- Seen State
============================================
.. automodule:: dropbox.seen_state
:members:
:show-inheritance:
:special-members: __init__
:undoc-members:
:mod:`dropbox.sharing` -- Sharing
============================================
.. automodule:: dropbox.sharing
:members:
:show-inheritance:
:special-members: __init__
:undoc-members:
:mod:`dropbox.team` -- Team
============================================
.. automodule:: dropbox.team
:members:
:show-inheritance:
:special-members: __init__
:undoc-members:
:mod:`dropbox.team_common` -- Team Common
============================================
.. automodule:: dropbox.team_common
:members:
:show-inheritance:
:special-members: __init__
:undoc-members:
:mod:`dropbox.team_log` -- Team Log
============================================
.. automodule:: dropbox.team_log
:members:
:show-inheritance:
:special-members: __init__
:undoc-members:
:mod:`dropbox.team_policies` -- Team Policies
============================================
.. automodule:: dropbox.team_policies
:members:
:show-inheritance:
:special-members: __init__
:undoc-members:
:mod:`dropbox.users` -- Users
============================================
.. automodule:: dropbox.users
:members:
:show-inheritance:
:special-members: __init__
:undoc-members:
:mod:`dropbox.users_common` -- Users Common
============================================
.. automodule:: dropbox.users_common
:members:
:show-inheritance:
:special-members: __init__
:undoc-members:
********
Tutorial
********
For a tutorial on how to get started, please visit our
`developers page
<https://www.dropbox.com/developers-preview/documentation/python#tutorial>`_.
Metadata-Version: 1.1
Name: dropbox
Version: 8.7.1
Summary: Official Dropbox API Client
Home-page: http://www.dropbox.com/developers
Author: Dropbox
Author-email: dev-platform@dropbox.com
License: MIT License
Description: Dropbox for Python
==================
.. image:: https://travis-ci.org/dropbox/dropbox-sdk-python.svg?branch=v8.7.1
: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