kobo-wall-calendar/kobo_wall_calendar/__init__.py

25 lines
881 B
Python

"""# Kobo Calendar Server
Small calendar web-server pulling from ICAL files, and presenting events in
a lightweight HMTL frontend.
The motivation was to create a lightweight wall calendar to use with an old
[Kobo Aura e-reader](https://en.wikipedia.org/wiki/Kobo_Aura), to take
advantage of the its e-ink screen, but I had problems getting it to run 24/7.
## Example usage
1. Add ICAL links to any [SecretLoader
compatible](https://gitfub.space/Jmaa/secret_loader) location, for the key
`ical_links`. Simplest approach is to add them to a file under
`secrets/ical_links`. ([Google Calendar hidden ICAL
links](https://support.google.com/calendar/answer/37648) works great here.)
2. Launch server using something like: `python -m kobo_wall_calendar`
3. Navigate to <http://localhost:8080/>.
4. Enjoy
"""
__all__ = ['__version__']
from ._version import __version__