anufrievroman / calcure

Modern TUI calendar and task manager with minimal and customizable UI.
https://anufrievroman.gitbook.io/calcure
MIT License
1.55k stars 44 forks source link
calendar python python3 task-manager terminal todo tui

Calcure

Modern TUI calendar and task manager with customizable interface. Manages your events and tasks, displays birthdays from your abook, and can import events and tasks from calcurse and taskwarrior.

See documentation for more information.

screenshot

Features

Installation

Linux and Mac OS

There are several ways to install:

pipx install calcure - the up-to-date version from PyPi. You may need to install pipx first.

yay -S calcure - AUR package is available. Upvote to support the project!

calcure is also available as NixOS package.

Windows

  1. Install Windows Terminal app from the Microsoft Store.
  2. Install Python 3.x also from the Microsoft Store (if you just type python in the Windows Terminal app it will offer you to install)
  3. Install the program and libraries by typing in the Windows Terminal pip install windows-curses calcure
  4. Now you can finally run it by typing in the Windows Terminal python -m calcure

Upgrade to the most recent version

pipx upgrade calcure

Dependencies

Usage

Run calcure in your terminal. You may need to restart your terminal after the install.

Syncing with cloud calendars

This page in documentation shows examples how to sync and display in read-only mode events and tasks from Nextcloud, Google, and other calendars.

User arguments

Various user arguments can be added started in special mods add tasks and events etc.

Key bindings

List of all key bindings can be accessed in the wiki and via ? key in the program.

Settings

Example of config.ini file and explanations of all settings are available in the documentation. On the first run, program will create a config.ini file where you can edit parameters, colors, and icons at ~/.config/calcure/config.ini.

Troubleshooting

Typical problems and solutions are described in documentation. If you faced a new problem, don't hesitate to open an issue.

Contribution

Full information about contribution is available in the documentation.

Support

I am not a professional developer and work on open-source projects in my free time. If you'd like to support the development, consider donations via buymeacoffee or cryptocurrencies: