# README for agenda
This small python project uses [python3-caldav](https://github.com/python-caldav/caldav) to connect to my calendar, and then generates a summary agenda for my day. It is very basic, but it gets my job done. I use this in a cron job to send an email to myself before the day starts. I always check email, but I apparently forget to check my calendar.

## Upstream
This project's upstream is at <https://bgstack15.ddns.net/cgit/agenda>.

## Alternatives
None researched. There's a million ways to get a summary of your day in any calendaring program.

## Reason for existence
For myself.

## Using
Only a basic library exists; no frontend exists. In an interactive python3 shell, you would run:

    import importlib, agenda
    print(agenda.summarize("2023-05-17",url="https://example.com/radicale/",username="bgstack15",password="plaintext"))

You can also pass a datetime.datetime or datetime.date object instead of a `YYYY-MM-DD` string.

## Dependencies

* python3-caldav

## Building
None

## References
See references heading in the [file](agenda.py).