From bd8b308f9ae3d4bc957d9bb8be2b98fb370e1676 Mon Sep 17 00:00:00 2001 From: Hans Lellelid Date: Fri, 27 Dec 2013 09:57:54 -0500 Subject: [PATCH] Updating docs and version for next release --- MANIFEST.in | 3 ++- docs/index.rst | 3 ++- docs/usage/overview.rst | 2 +- setup.py | 2 +- stravalib/client.py | 1 + 5 files changed, 7 insertions(+), 4 deletions(-) diff --git a/MANIFEST.in b/MANIFEST.in index 2c317ec5..2a0d3d6b 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1 +1,2 @@ -include docs/news.rst +recursive-include docs * +recursive-include stravalib/tests/resources * diff --git a/docs/index.rst b/docs/index.rst index f99aaa45..6b9b7cf9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -36,7 +36,8 @@ list this package as a dependency in your own `install_requires` directive in `s download it and explore Strava content in your favorite python REPL. In order to make use of this library, you will need to have access keys for one or more Strava users. -These access keys can be fetched by +These access keys can be fetched by using helper methods provided by :class:`stravalib.client.Client` class. +See :ref:`auth` for more details. Usage ----- diff --git a/docs/usage/overview.rst b/docs/usage/overview.rst index 65c7cff2..63b5b4e9 100644 --- a/docs/usage/overview.rst +++ b/docs/usage/overview.rst @@ -10,7 +10,7 @@ Retrieving Single Entities ========================== The simplest case are the client methods that return single entities. The entity object -types are instances of :module:`stravalib.model` classes. For example:: +types are instances of :mod:`stravalib.model` classes. For example:: client = Client(access_token=JOHNS_ACCESS_TOKEN) athlete = client.get_athlete() # Get John's full athlete record diff --git a/setup.py b/setup.py index a8e5b947..cbd9b196 100644 --- a/setup.py +++ b/setup.py @@ -11,7 +11,7 @@ use_setuptools() from setuptools import setup, find_packages -version = '0.2dev3' +version = '0.2.0' news = os.path.join(os.path.dirname(__file__), 'docs', 'news.rst') news = open(news).read() diff --git a/stravalib/client.py b/stravalib/client.py index 23543818..8a5ded00 100644 --- a/stravalib/client.py +++ b/stravalib/client.py @@ -767,6 +767,7 @@ def wait(self, timeout=None, poll_interval=1.0): Wait for the upload to complete or to err out. Will return the resulting Activity or raise an exception if the upload fails. + :param timeout: The max seconds to wait. Will raise TimeoutExceeded exception if this time passes without success or error response. :type timeout: float