{"id":13770929,"url":"https://github.com/tenJirka/reGenda","last_synced_at":"2025-05-11T03:32:57.968Z","repository":{"id":190264854,"uuid":"681611972","full_name":"tenJirka/reGenda","owner":"tenJirka","description":"Simple agenda app for reMarkable tablets","archived":false,"fork":false,"pushed_at":"2023-10-20T07:55:49.000Z","size":889,"stargazers_count":21,"open_issues_count":2,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-11-17T06:40:30.355Z","etag":null,"topics":["caldav-client","remarkable-tablet"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tenJirka.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null},"funding":{"github":"tenJirka"}},"created_at":"2023-08-22T11:41:05.000Z","updated_at":"2024-11-08T00:15:37.000Z","dependencies_parsed_at":"2023-08-23T22:16:11.456Z","dependency_job_id":"e8716d75-7483-49cb-b573-3ae66285e6be","html_url":"https://github.com/tenJirka/reGenda","commit_stats":null,"previous_names":["tenjirka/regenda"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tenJirka%2FreGenda","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tenJirka%2FreGenda/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tenJirka%2FreGenda/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tenJirka%2FreGenda/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tenJirka","download_url":"https://codeload.github.com/tenJirka/reGenda/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253514352,"owners_count":21920327,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["caldav-client","remarkable-tablet"],"created_at":"2024-08-03T17:00:44.900Z","updated_at":"2025-05-11T03:32:57.311Z","avatar_url":"https://github.com/tenJirka.png","language":"Python","funding_links":["https://github.com/sponsors/tenJirka"],"categories":["Applications"],"sub_categories":["Other APIs"],"readme":"# reGenda - Agenda app for reMarkable\n\nreGenda is **read only** (for now) agenda app for reMarkable tablets. I would like to add edit features, but it's in the future.\n\n**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.**\n**Connection with iCloud should work, see [configuration section](https://github.com/tenJirka/reGenda#icloud) for more info.**\n\n**Please do not use calendars with the same names, this will confuse the app.**\n\n## What it can do\n\n- Show your day based agenda\n- Show event details\n- Show events from multiple calendars\n- You can choose which calendar will be displayed\n- You can choose language of UI (only English and Czech are currently supported)\n- Fast time travel by selecting day from month based view\n- Fast return to today\n- Show events from multiple caldav servers\n\nMaybe more, check preview or try it your self.\n\n## Preview\n\n\u003cimg src=\"previews/Preview1.gif\" style=\"zoom:67%;\" /\u003e\n\n# Installation\n\n## From Toltec\n\nreGenda can be installed from Toltec by this command:\n\n```bash\nopkg install regenda\n```\n\n**See [configuration section](https://github.com/tenJirka/reGenda#configuration), if installing for the first time.**\n\n## Manually\n\nYou will probably not be able to install all dependencies if you do not have installed Toltec on your reMarkable.\n\n### Dependencies\n\n- git\n- python3\n- python3-pip\n- python3-lxml\n- simple\n- display (for reMarkable 2)\n- some more python modules that you have to install via pip (see Installation bellow)\n\nCan by installed by:\n\n```bash\nopkg install git python3 python3-pip python3-lxml simple # display\n```\n\n### Installation\n\n1. Download repository to directory of your choice:\n\n   ```bash\n   git clone https://github.com/tenJirka/reGenda.git\n   ```\n\n2. Install python modules:\n\n   ```bash\n   cd reGenda\n   pip install -r requirements.txt\n   ```\n\n3. Create your config file:\n\n   ```bash\n   cp config.yml.example config.yml\n   ```\n\n4. **Edit your config file - see configuration section in this README.**\n\n5. Move config file to it's place:\n\n   ```bash\n   mkdir -p /opt/etc/reGenda\n   mv config.yml.example /opt/etc/reGenda/config.yml\n   ```\n\n6. Run reGenda:\n\n   ```bash\n   chmod +x run.py\n   ./run.py\n   ```\n\n### Update\n\n```bash\ncd \"reGenda dir\"\ngit pull\n```\n\n## Configuration\n\nServers that reGegenda communicates with can't be set up from UI, so you **have to** edit config file before using it.\n\nThis should be necessary to do only once.\n\nConfig file destination should be  `/opt/etc/reGenda/config.yml`. Default location of example config file is `/opt/etc/reGenda/config.yml.example`.\n\nIf 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.\n\nYou can do this by this command:\n\n```bash\nnano /opt/etc/reGenda/config.yml # or different text editor like vim\n```\n\nYour configuration file should look like this:\n\n```yaml\ntimezone: UTC       # see https://mljar.com/blog/list-pytz-timezones/ for all available timezones\nsources:\n  Personal:         # Name of server (can be anything, but have to be unique in this config)\n    type: server    # Just keep this, it's preparation for calendars specified by url\n    user: \"your user name\"\n    url: \"your server url\"\n    password: \"your password\"\n  #Work:            # Another server or just different user\n  #   type: server \n  #   user: \"your user name\"\n  #   url: \"your server url\"\n  #   password: \"your password\"\n```\n\nSetting 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).\n\n### iCloud\nHere is an example for iCloud settings.\n```yaml\nsources:\n  iCloud:         # Name of server (can be anything, but have to be unique in this config)\n    type: server    # Just keep this, it's preparation for calendars specified by url\n    url: https://caldav.icloud.com/\n    user: \u003cyour-apple-id-here\u003e\n    password: \u003capp-specific-password\u003e\n```\nThanks [@jedahan](https://github.com/jedahan) for this example. More information can be found [here](https://github.com/tenJirka/reGenda/discussions/5).\n\n## FAQ\n\nMaybe this section should be named \"Things I would like you to knew\", but it wont be so attractive, so…\n\n### Why is it so slow?\n\nreGenda don't save any information to device, so wherever you change date, it have to download events first.\n\nIf the app launch is very slow it can depends on multiple things.\n\n- Your server can be slow\n- Your Internet connection can be slow\n- Try charge up your remarkable, I have suspicion that it can have impact on lunch time, not sure why\n\nLunch 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.\n\n### Why is Czech supported language\n\nBecause 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.\n\n### Why is CalDav supported instead of Google calendar\n\nThat's because I  developed reGenda for my self originally and I use CalDav. It would be impractical develop app that I can't use.\n\n### I would like to develop apps for reMarkable tablet too, how?\n\nYou should checkout [remarkable.guide]( https://remarkable.guide/) at first place.\n\nreGenda 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).\n\n## Credits\n\n- [caldav](https://github.com/python-caldav/caldav) - Module used to communicate with servers\n- [rmkit](https://rmkit.dev/) - Which these app stands on\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FtenJirka%2FreGenda","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FtenJirka%2FreGenda","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FtenJirka%2FreGenda/lists"}