Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tenJirka/reGenda
Simple agenda app for reMarkable tablets
https://github.com/tenJirka/reGenda
remarkable-tablet
Last synced: 3 months ago
JSON representation
Simple agenda app for reMarkable tablets
- Host: GitHub
- URL: https://github.com/tenJirka/reGenda
- Owner: tenJirka
- License: gpl-3.0
- Created: 2023-08-22T11:41:05.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-20T07:55:49.000Z (about 1 year ago)
- Last Synced: 2024-05-20T00:35:05.558Z (6 months ago)
- Topics: remarkable-tablet
- Language: Python
- Homepage:
- Size: 868 KB
- Stars: 12
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-reMarkable - reGenda - An agenda-based calendar for reMarkable. (Applications / Other APIs)
README
# reGenda - Agenda app for reMarkable
reGenda is **read only** (for now) agenda app for reMarkable tablets. I would like to add edit features, but it's in the future.
**Currently, reGenda only works with caldav servers that require login, such as [Nextcloud](https://nextcloud.com/) (only tested with Nextcloud so far). Other calendars specified by url or Google calendar for example are not supported and I don't guarantee they will be, but I know they might be more attractive to others.**
**Connection with iCloud should work, see [configuration section](https://github.com/tenJirka/reGenda#icloud) for more info.**
**Please do not use calendars with the same names, this will confuse the app.**
## What it can do
- Show your day based agenda
- Show event details
- Show events from multiple calendars
- You can choose which calendar will be displayed
- You can choose language of UI (only English and Czech are currently supported)
- Fast time travel by selecting day from month based view
- Fast return to today
- Show events from multiple caldav servers
Maybe more, check preview or try it your self.
## Preview
# Installation
## From Toltec
reGenda can be installed from Toltec by this command:
```bash
opkg install regenda
```
**See [configuration section](https://github.com/tenJirka/reGenda#configuration), if installing for the first time.**
## Manually
You will probably not be able to install all dependencies if you do not have installed Toltec on your reMarkable.
### Dependencies
- git
- python3
- python3-pip
- python3-lxml
- simple
- display (for reMarkable 2)
- some more python modules that you have to install via pip (see Installation bellow)
Can by installed by:
```bash
opkg install git python3 python3-pip python3-lxml simple # display
```
### Installation
1. Download repository to directory of your choice:
```bash
git clone https://github.com/tenJirka/reGenda.git
```
2. Install python modules:
```bash
cd reGenda
pip install -r requirements.txt
```
3. Create your config file:
```bash
cp config.yml.example config.yml
```
4. **Edit your config file - see configuration section in this README.**
5. Move config file to it's place:
```bash
mkdir -p /opt/etc/reGenda
mv config.yml.example /opt/etc/reGenda/config.yml
```
6. Run reGenda:
```bash
chmod +x run.py
./run.py
```
### Update
```bash
cd "reGenda dir"
git pull
```
## Configuration
Servers that reGegenda communicates with can't be set up from UI, so you **have to** edit config file before using it.
This should be necessary to do only once.
Config file destination should be `/opt/etc/reGenda/config.yml`. Default location of example config file is `/opt/etc/reGenda/config.yml.example`.
If you are installing from package, post install script will create config file for you if not exists yet, but you have to fill information about your servers and your users.
You can do this by this command:
```bash
nano /opt/etc/reGenda/config.yml # or different text editor like vim
```
Your configuration file should look like this:
```yaml
timezone: UTC # see https://mljar.com/blog/list-pytz-timezones/ for all available timezones
sources:
Personal: # Name of server (can be anything, but have to be unique in this config)
type: server # Just keep this, it's preparation for calendars specified by url
user: "your user name"
url: "your server url"
password: "your password"
#Work: # Another server or just different user
# type: server
# user: "your user name"
# url: "your server url"
# password: "your password"
```
Setting the time zone in the configuration file is optional, if not set, the TZ system variable or the system time zone will be used (since version 0.0.3).
### iCloud
Here is an example for iCloud settings.
```yaml
sources:
iCloud: # Name of server (can be anything, but have to be unique in this config)
type: server # Just keep this, it's preparation for calendars specified by url
url: https://caldav.icloud.com/
user:
password:
```
Thanks [@jedahan](https://github.com/jedahan) for this example. More information can be found [here](https://github.com/tenJirka/reGenda/discussions/5).
## FAQ
Maybe this section should be named "Things I would like you to knew", but it wont be so attractive, so…
### Why is it so slow?
reGenda don't save any information to device, so wherever you change date, it have to download events first.
If the app launch is very slow it can depends on multiple things.
- Your server can be slow
- Your Internet connection can be slow
- Try charge up your remarkable, I have suspicion that it can have impact on lunch time, not sure why
Lunch takes around 10 seconds to me, but I experience one day when it takes slightly below 40, and I wasn't able to find out why. Lunch time changes even when trying different account on same server.
### Why is Czech supported language
Because I'm from Czechia and Czech is matter of the heart for me, so the app was originally only in Czech, English was added later before publishing.
### Why is CalDav supported instead of Google calendar
That's because I developed reGenda for my self originally and I use CalDav. It would be impractical develop app that I can't use.
### I would like to develop apps for reMarkable tablet too, how?
You should checkout [remarkable.guide]( https://remarkable.guide/) at first place.
reGenda uses by me written [Simple](https://rmkit.dev/apps/sas) wrapper for Python that you can find [here](https://github.com/tenJirka/rm-pySAS), or you can check similar Python module that I didn't know already exists [Carta](https://github.com/Jayy001/Carta).
## Credits
- [caldav](https://github.com/python-caldav/caldav) - Module used to communicate with servers
- [rmkit](https://rmkit.dev/) - Which these app stands on