intervalsicu 0.1.4

A basic interface to the Intervals.icu system

Intervals.ICU Python API

This API provides a basic interface to work with the Intervals.ICU. You can obtain further documentation for the Intervals.ICU site by following the instructions from this post.

API functionality is described in the thread above. This API aims to provide all functionality, but there are gaps. Please open an issue (or a PR) for any missing functionality.

Full documentation can be found here

Changelog

0.1.4 Added a strict flag to the Intervals library. This flag tells the library whether it should validate objects received from the server. If object validation fails, a TypeError is raised.

This flag was added because updates to the backend objects can unintentionally break client libraries. So you can toggle this flag to stop validating objects.

This flag is True by default, to preserve backwards compatibility. You must manually set the flag to False to stop validating objects.

Examples

Update a field in your wellness document

import pprint
from datetime import date

from intervalsicu import Intervals


def wellness():
    svc = Intervals("MY ATHLETE ID", "MY API KEY", strict=False)

    start = date.fromisoformat("2021-03-10")
    wellness = svc.wellness(start)
    wellness['restingHR'] = 57
    wellness = svc.wellness_put(wellness)
    pprint.pprint(wellness)


if __name__ == "__main__":
    wellness()

Write all your activities to a CSV file

import csv
import io

from intervalsicu import Intervals


def activities_to_csv():
    svc = Intervals("MY ATHLETE ID", "MY API KEY", strict=False)

    activities_csv = io.StringIO(svc.activities())

    with open('example/activities.csv', 'w') as w:
        reader = csv.reader(activities_csv)
        writer = csv.writer(w)
        
        for row in reader:
            writer.writerow(row)


if __name__ == "__main__":
    activities_to_csv()

Download a list of events in JSON.

import pprint
from datetime import date

from intervalsicu import Intervals


def events():
    svc = Intervals("MY ATHLETE ID", "MY API KEY", strict=False)

    start = date.fromisoformat("2021-03-08")
    end = date.fromisoformat("2021-03-09")
    events = svc.events(start, end)
    pprint.pprint(events)


if __name__ == "__main__":
    events()