Skip to main content

A Typer CLI to interact with a Vikunja instance

Project description

Vodo

This is a simple command line interface for vikunja. It is recommended that you use a terminal that has support for nerd fonts and that you have a nerd font installed. I will work on a config option to remove all of the fancy display bells and whistles and just use text for everything, but this is not available at the moment.

a screenshot of what the tool looks like

Installation

vodo is available via pypi

pip install vodo

Or, if you are using uv

uv tool install vodo

Usage

The easiest way to see the available options is through the --help option. The high-level commands are listed below

Command Description
tasks View all tasks. Use the --done option to show completed tasks
view View a task by passing the task id as the argument
add Add a task using the title as an argument. Add other elements through options
edit Edit a task view the task id. Interactive.
done Mark a task as complete via the task id.

Configuration

The application expects there to be configuration variables available at ~/.config/vikunja/config.toml. I will be adding options to add additional paths in the feature. The file should look like this.

api_url = "https://vikunja.example.com" # required
token = "your_api_token" # required
due_soon_days = 3 # optional

due_soon_days represents the number of days away a due date should be before being highlighted red.

Contributing

Pull requests and issues are welcome. This repository uses the following:

  • uv for package mangement
  • ruff for python formatting and linting
  • mdformat for markdown formatting
  • pre-commit for hooks

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vodo-0.3.0.tar.gz (8.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vodo-0.3.0-py3-none-any.whl (8.3 kB view details)

Uploaded Python 3

File details

Details for the file vodo-0.3.0.tar.gz.

File metadata

  • Download URL: vodo-0.3.0.tar.gz
  • Upload date:
  • Size: 8.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.5

File hashes

Hashes for vodo-0.3.0.tar.gz
Algorithm Hash digest
SHA256 f2536d0c42ee33da38fb4b6a2b33cebd3a5992d1067787a052117ecae38938f6
MD5 f392515b04ff11f5752645064c8477cb
BLAKE2b-256 6362fc5db52e387cc8c5d77c0d019023995b25f75fe8a56020d916c328ebc91f

See more details on using hashes here.

File details

Details for the file vodo-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: vodo-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 8.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.5

File hashes

Hashes for vodo-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fea831c58c9702535c19821c73252f9c1d66605f45d230e3695ba39ee7c19755
MD5 bc43ec24236a760a7af4a1cda9ec1cfc
BLAKE2b-256 61c4f43b435015d8f07552590b09e5da73ef6da6109385d873d6a049c86471db

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page