Metadata-Version: 2.1
Name: strava-flyby
Version: 0.0.4
Summary: Python client for Strava Flyby
Home-page: https://github.com/sladkovm/strava-flyby
Author: Maksym Sladkov
Author-email: sladkovm@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Scientific/Engineering
Description-Content-Type: text/markdown
Requires-Dist: pandas
Requires-Dist: requests


# Python client for Strava Flyby

[![PyPI version](https://badge.fury.io/py/strava-flyby.svg)](https://badge.fury.io/py/strava-flyby)
[![Build Status](https://travis-ci.org/sladkovm/strava-flyby.svg?branch=master)](https://travis-ci.org/sladkovm/strava-flyby)


## Install

$ pip install strava-flyby


## Usage

*strava-flyby* provides a convenience object wrapping of the *Strava Labs Flyby API* response. Next to providing a direct access to the unmodified content of the *Flyby API* response, the object will expose number of convenience attributes and methods to access the list of activity ids, matches and athletes.  

Create a *flyby* object using the Strava activity ID with a help of the `flyby()` factory function:
```python
from flyby import flyby
fb = flyby(activity_id=12345)
print(fb)
>>> <flyby.Flyby object at 0x000002D65BE952E8>
```

List of implemented methods and attributes:
```python
dir(fb)
>>> [..., 'raw_activity', 'raw_athletes', 'raw_content', 'raw_matches',
          'ids', 'get_ids', 'matches_to_json', 'matches_to_list']
```

Filter by distance in km and print all matched ids:
```python
print(fb.get_ids(distance=(110, 130)))
```

Dump filtered by distance flattened matches into a list:
```python
print(fb.matches_to_list(distance=120, tol=0.1))
```


