/pyminder

Beeminder library for Python

Primary LanguagePythonMIT LicenseMIT

pyminder

I use Beeminder in a lot of my Python projects, and I find myself writting the same helper functions multiple times. This repository will serve as a place for me to store this functionality and make it accessible to other people.

Installation

pip3 install --user pyminder

Usage

import time
from pyminder.pyminder import Pyminder

pyminder = Pyminder(user='[your username]', token='[your api token]')

goals = pyminder.get_goals()
goal = goals[0]

# Goal objects expose all API data as dynamic properties.
# http://api.beeminder.com/#attributes-2
slug = goal.slug
rate = goal.rate

# Goal objects also implement a handful of helper functions.
# Note: These functions probably contain bugs! Issues & pull requests welcome.
# https://github.com/narthur/pyminder/blob/master/pyminder/goal.py
now = time.time()
sum_ = goal.get_data_sum(now)
needed = goal.get_needed(now)

Links

Development

  • Set up a virtual environment in PyCharm so you aren't using the global Python env. This will allow you to avoid conflicts of dependencies.

Deployment

Information