https://github.com/remindersdevs/reminders
An open source reminder app
https://github.com/remindersdevs/reminders
gnome gtk4 libadwaita linux python reminders
Last synced: 7 months ago
JSON representation
An open source reminder app
- Host: GitHub
- URL: https://github.com/remindersdevs/reminders
- Owner: remindersdevs
- License: gpl-3.0
- Created: 2023-01-30T00:00:15.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-26T21:25:06.000Z (almost 2 years ago)
- Last Synced: 2024-05-14T03:04:22.757Z (almost 2 years ago)
- Topics: gnome, gtk4, libadwaita, linux, python, reminders
- Language: Python
- Homepage:
- Size: 4.6 MB
- Stars: 114
- Watchers: 4
- Forks: 19
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# Reminders, an open source reminder app
## Features
- Set recurring reminders
- Schedule notifications
- Sort, filter, and search for reminders
- Mark reminders as important or complete
- Organize reminders using lists
- Optionally play a sound when notifications are sent
- Optionally sync with Microsoft To Do
- Optionally sync with CalDAV servers
- Import and export ical/ics files
## Translators
You can translate Reminders on [Weblate](https://hosted.weblate.org/engage/reminders/), or through GitHub pull requests.
## Manual installation
### Installing dependencies (Flatpak):
```
flatpak install flathub org.gnome.Sdk//44
```
```
flatpak install flathub org.gnome.Platform//44
```
You will also need `flatpak-builder`
### Building (Flatpak):
```
flatpak-builder --user --install --force-clean build-dir flatpak/io.github.remindersdevs.Reminders.yml
```
```
flatpak run io.github.remindersdevs.Reminders.Devel --restart-service
```
### Dependencies (generic):
- `PyGObject`
- `Meson`
- `Libadwaita`
- `GLib`
- `GSound`
- `WebKitGTK`
- `python3-msal`
- `python3-requests`
- `python3-caldav`
- `python3-icalendar`
- `python3-setuptools`
### Building (generic):
```
meson build -Ddevel=true
```
```
ninja -C build install
```
```
remembrance --restart-service
```
## Todo
- Windows port (Need to look into dbus support on Windows)
- Add a debug mode and make it easier to get logs
- Maybe make a GNOME Shell extension that lets you view your reminders (This probably will never happen)
- Maybe integrate the search with GNOME Shell (Also probably not happening)
If you want to contribute anything, just open a pull request. Depending on what you are going to contribute, you might want to [email me](mailto:dgsasha04@gmail.com) first. This will let me help you get started and it will also help me make sure that multiple people aren't working on the same feature without knowing it.
## Reminders DBus Service Documentation
The documentation can be found [here](REMINDERS_SERVICE.md). You probably will want to select the tag for the latest release of Reminders when looking at the documentation.
## Copying
Reminders is licensed under the terms of the [GNU General Public License, version 3 or later](https://www.gnu.org/licenses/gpl-3.0.txt).