https://github.com/hng/germine
A gemini application that displays calendar events from an URL to an .ics file.
https://github.com/hng/germine
gemini
Last synced: 3 months ago
JSON representation
A gemini application that displays calendar events from an URL to an .ics file.
- Host: GitHub
- URL: https://github.com/hng/germine
- Owner: hng
- Created: 2022-12-29T16:31:25.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-12-30T18:01:48.000Z (over 2 years ago)
- Last Synced: 2024-12-31T02:27:50.908Z (5 months ago)
- Topics: gemini
- Language: Python
- Homepage:
- Size: 20.5 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Germine
A gemini application that displays calendar events from an URL to an .ics file. Besides listing the events a simple search can be used (searching summary and location fields).
Developed with the great [jetforce](https://github.com/michael-lazar/jetforce) gemini server framework. Not really optimised atm but functional.
## Configuration
The following ENV variables are used to configure Germine:
`GERMINE_HOST`: The server's host should be set to the local socket that you want to bind to, see [jetforce documentation](https://github.com/michael-lazar/jetforce#usage) (default: `127.0.0.1`)
`GERMINE_HOSTNAME`: The server's hostname should be set to the DNS name that you expect to receive traffic from, see [jetforce documentation](https://github.com/michael-lazar/jetforce#usage) (default: `localhost`)
`GERMINE_CAL_URL`: HTTP(S) URL to an .ics file
`GERMINE_DATEFORMAT_DAY`: dateformat string used for day headers (default: `%a, %d.%m.%y`)
`GERMINE_DATEFORMAT_EVENT`: dateformat string used for event headers (default: `%H:%Mh`)
`GERMINE_SEARCH_INPUT_MESSAGE`: string displayed when opening search input (default: "Search query (searches in event summary and location)")
### Templates
Templates for the header and the additional information displayed when searching can be found in the `templates/` folder. Overwrite them with your own content.
## Setup
Dependencies:
* Python 3.10
* Poetry
1. Clone the repository.
2. Run `poetry install`
3. Start the server with: `GERMINE_CAL_URL="https://hermine-termine.net/hermine/static/ics/hermine.ics" poetry run python -m germine_termine.app` (you need to supply `GERMINE_CAL_URL` with an http(s) url to an .ics file)