Metadata-Version: 2.4
Name: bee-scheduler
Version: 0.0.2
Summary: A scheduling library for beeminder.
Project-URL: Homepage, https://github.com/maxtrussell/bee-scheduler
Project-URL: Issues, https://github.com/maxtrussell/bee-scheduler/issues
Author-email: Max Trussell <maxtrussell@gmail.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Requires-Dist: requests
Description-Content-Type: text/markdown

# Bee Scheduler

Allows for setting rates for arbitrary blocks of time in [Beeminder](https://www.beeminder.com)a.

## Usage

To use this library, two environment variables need to be set first:
```bash
$ export BEEMINDER_USER="<beeminder username>"
$ export BEEMINDER_TOKEN="<beeminder api token>"
```

This information may be found at https://www.beeminder.com/api/v1/auth_token.json

This library may be installed using pip:
```bash
$ pip install bee-scheduler
```

To schedule a break (rate=0) for the weekend of April 19th to April 20th:
```python
from datetime import date

from bee_scheduler.scheduler import schedule_rate

start = date(year=2025, month=4, day=19)
end = date(year=2025, month=4, day=20)
rate = 0
schedule_rate(goal_name, start, end, rate)
```

And here you can see the resulting break scheduled in a beeminder graph:
![graph with break](https://files.maxtrussell.net/share/3e251cf9-a9bd-48c9-b705-d0cebc131493)
