bcongdon / bolero Goto Github PK

View Code? Open in Web Editor NEW

18.0 2.0 1.0 141 KB

:dancer: Construct your personal API

License: MIT License

Python 99.35% Makefile 0.41% Shell 0.24%

data-collector api-consumer quantified-self flask-application

bolero's Introduction

bolero

💃 Construct your personal API

Bolero backs up and cleans personal data, and allows you to expose that data as a personal RESTful API.

Methodology

Consuming APIs to access your personal data is a pain. API wrappers make this work less tedious, but each service still has it's own authentication mechanism and data schema. Bolero abstracts away the API layer of downloading your data. Simply authenticate a Bolero tracker with each of your services, and access your data locally via RESTful API or SQL database.

Bolero aims to provide a platform on which you can build your own quantified self visualizations and data munging experiments. Get fast, reliable, and immediate access to the lifetime all the data you store online.

Installation

Local Installation

Install Postgres and have it running locally.

Clone the bolero repo with:

git clone https://github.com/bcongdon/bolero
cd bolero

Install bolero's dependencies using Pipenv

# Install bolero's pip dependencies
pipenv install

Run the startup script.
```
./start.py
```

Heroku Deployment

TODO

Trackers

Trackers live in bolero/trackers/ and provide both models and API scrapers for various services.

Supported Services:

Fitbit
MyFitnessPal
Nokia Health (formerly Withings)
Todoist
Twitter
Wunderlist

bolero's People

Contributors

Stargazers

Watchers

Forkers

c4p-n1ck

bolero's Issues

Tracker Implementation documentation

Should have a simple "howto" guide on how to implement a new Tracker

Improve Methodology Documentation

Need to have some type of explanation as to what problem (API data warehousing) this project is trying to solve in the README.

Todoist Tracker

Implement a Todoist tracker with similar functionality to the Wunderlist tracker.

Further decouple plugins from "core"

Plugins should be more like plugins than internal modules.
It's fine to have a list of modules as strings in a configuration file and import them via __import__.

The idea is to have bolero be a relatively lean framework, and push a lot of the complexity / implementation out to the tracker plugins.

Rework Tracker loading

Per #1, trackers will be objects instead of modules.

Thus, tracker loading will need to be updated from the naive importlib.import_module approach.

It will probably be sufficient to do something like youtube-dl's mass-import, and then selectively authenticate / activate the enabled trackers.

Standardize tracker object / behavior

Trackers should be objects, instead of formless modules. They behave more like objects already, and it's more idiomatic to call duck-typed functions of a subclass to Tracker than to a module.

Trackers should be able to do the following:

Authenticate the API client
- handleAuthentication()
Do some type of regular scraping function
- scrape()
Do a complete 'refresh' of their object's database
- backfill()

Trackers should be distinct from their associated models, and should only have simple CRUD tasks on the actual data.