A TUI app for browsing and editing VJOURNAL iCalendar files in a directory.
Find a file
2024-12-09 10:20:07 +00:00
src/vjournal_explorer Add 'version' cmdline option. 2024-12-09 10:20:07 +00:00
tests Template cli app (with click). 2024-11-25 22:54:21 +00:00
.gitignore Template cli app (with click). 2024-11-25 22:54:21 +00:00
LICENSE Add license, update readme. 2024-12-04 08:57:38 +00:00
pdm.lock Add reading a config file. Remove textual-dev dependency. 2024-12-08 11:14:44 +00:00
pyproject.toml Add reading a config file. Remove textual-dev dependency. 2024-12-08 11:14:44 +00:00
README.md Add reading a config file. Remove textual-dev dependency. 2024-12-08 11:14:44 +00:00

vjournal-explorer

... is an app for browsing and editing VJOURNAL files in a directory.

VJOURNAL is a type of event in iCalendar standard, so these files can be intermixed with and synchronised (e.g. though CalDav protocol) along with the rest of your iCalendar/ics setup.

I personally use vdirsyncer to synchronise my nextcloud calendars with a directory with ics files on my computer. I use this app to interact with VJOURNAL-type entries among them.

As of writing this, among full-blown calendar/todo applications, evolution can also interact with VJOURNAL entries (they call them 'Memos'); and jtx Android app can do so as well.

installation

At the moment, the code exists only in this repo.

Perhaps the most convenient way to install this is with pipx:

pipx install git+https://git.drak.xyz/flabbergast/vjournal-explorer

After this you'll have the vje command available in terminal.

running

Run vje DIRECTORY in your terminal.

When ran without arguments, vje will try to read a configuration file $HOME/.config/vjournal-explorer/config. This can be used to set DIRECTORY like so:

directory="/home/USER/vjournal_directory"

Run vje --help for full list of options (for now rather short).

technical

vjournal-explorer expects a directory with ics (VCALENDAR) files, each of them with a single VJOURNAL entry. However VCALENDAR files can have multiple entries. For now, one needs to be careful with deleting entries -- this deletes the whole ics file. Other functionality should work fine.

todo

  • fix deleting (remove entry, check for empty vcal, clean up file if needed)