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
|
# Welcome to the Stravalib Documentation!
::::{grid} 2
:reverse:
:::{grid-item}
:columns: 12
:class: sd-fs-3
Stravalib is an open source Python package that makes it easier for you to
access the Strava v3 REST API using the Python programming language.
```{only} html

[](https://github.com/pyopensci/contributing-guide)
[](https://zenodo.org/badge/latestdoi/8828908)
```
:::
::::
::::{grid} 1 1 1 2
:class-container: text-center
:gutter: 3
:::{grid-item-card}
:link: get-started/index
:link-type: doc
✨ **Get Started Using Stravalib** ✨
^^^
New to Stravalib? This section is for you!
:::
:::{grid-item-card}
:link: contributing/how-to-contribute
:link-type: doc
✨ **Want to contribute?** ✨
^^^
We welcome contributions of all kinds to stravalib. Learn more about the many
ways that you can contribute.
:::
:::{grid-item-card}
:link: reference
:link-type: doc
✨ **Package Code (API) Documentation** ✨
^^^
Documentation for every method and class available to you
in the stravalib package.
:::
::::
## About the stravalib Python package
**stravalib** is a Python library for interacting with
[version 3](https://developers.strava.com/docs/reference/) of the
[Strava](https://www.strava.com) API. Our goal is to expose the entire user-facing
Strava V3 API.
The **stravalib** Python package provides easy-to-use tools for accessing and
downloading Strava data from the Strava V3 web service. Stravalib provides a
`Client` class that supports:
* Authenticating with stravalib
* Accessing and downloading Strava activity, club and profile data
* Making changes to account activities
It also provides support for working with date/time/temporal attributes
and quantities through the [Python Pint library](https://pypi.org/project/Pint/).
## Why use stravalib?
There are numerous reasons to use stravalib in your workflows:
* Stravalib returns your data in structured Python dictionaries with associated data types that make it easier to work with the data in Python.
* Relationships can be traversed on model objects to pull in related content "seamlessly".
* dates, times and durations are imported as Python objects making it easier to convert and work with this data.
* Stravalib provides built-in support for rate-limiting
* and more intelligent error handling.
:::{toctree}
:hidden:
:maxdepth: 2
🏠 Home <self>
:::
:::{toctree}
:hidden:
:caption: Get Started
Get Started <get-started/index>
:::
:::{toctree}
:hidden:
:caption: API Documentation
:maxdepth: 2
Code/API Reference <reference>
:::
:::{toctree}
:hidden:
:caption: Contribute
:maxdepth: 2
Contribute <contributing/intro.md>
:::
:::{toctree}
:hidden:
:caption: What's New
What's new <whats-new/stravalib-2>
:::
|