File: client.rst

package info (click to toggle)
stravalib 2.4-2
  • links: PTS, VCS
  • area: contrib
  • in suites: forky, sid
  • size: 5,340 kB
  • sloc: python: 4,462; makefile: 5
file content (131 lines) | stat: -rw-r--r-- 2,574 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
============
Client
============
.. currentmodule:: stravalib.client

The ``Client`` object class for interacting with the Strava v3 API. While
you can create this object without an access token, you will likely want
to create an access token to authenticate and access most of the Strava data
accessible via the API.


Main Classes
-------------
.. autosummary::
   :toctree: api/

   Client
   BatchedResultsIterator
   ActivityUploader


General methods and attributes
-------------------------------

.. autosummary::
   :toctree: api/

   Client.authorization_url
   Client.exchange_code_for_token
   Client.refresh_access_token
   Client.deauthorize

Athlete methods
-----------------
.. autosummary::
   :toctree: api/

   Client.get_activities
   Client.get_athlete
   Client.update_athlete
   Client.get_athlete_koms
   Client.get_athlete_stats
   Client.get_athlete_clubs
   Client.get_gear

Club related methods
--------------------
.. autosummary::
   :toctree: api/

   Client.join_club
   Client.leave_club
   Client.get_club
   Client.get_club_members
   Client.get_club_activities

Activity related methods
-------------------------
.. autosummary::
   :toctree: api/

   Client.get_activity
   Client.create_activity
   Client.update_activity
   Client.upload_activity
   Client.get_activity_zones
   Client.get_activity_comments
   Client.get_activity_kudos
   Client.get_activity_photos
   Client.get_activity_laps
   Client._validate_activity_type

Segment related methods
-------------------------
.. autosummary::
   :toctree: api/

   Client.get_segment_effort
   Client.get_segment
   Client.get_starred_segments
   Client.get_athlete_starred_segments
   Client.get_segment_efforts
   Client.explore_segments

Stream related methods
-------------------------

.. autosummary::
   :toctree: api/

   Client.get_activity_streams
   Client.get_effort_streams
   Client.get_segment_streams

Route related methods
----------------------

.. autosummary::
   :toctree: api/

   Client.get_routes
   Client.get_route
   Client.get_route_streams

Subscription related methods
-----------------------------

.. autosummary::
   :toctree: api/

   Client.create_subscription
   Client.handle_subscription_callback
   Client.handle_subscription_update
   Client.list_subscriptions
   Client.delete_subscription


Activity Uploader Constructor
-----------------------------
.. autosummary::
   :toctree: api/

   ActivityUploader

ActivityUploader methods
---------------------------

.. autosummary::
   :toctree: api/

   ActivityUploader.update_from_response