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

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.2.0.tar.gz (8.4 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.2.0-py3-none-any.whl (8.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for vodo-0.2.0.tar.gz
Algorithm Hash digest
SHA256 c3cde6456900ee8ad7d89ccb68754ce772a51c49003b3e51300684d989e5690b
MD5 2c5c78e961fc9ff1fd6363d8c6050867
BLAKE2b-256 5cc1ecc1201a5db9934ba31c99f2661e6cb4dfa97cb820439fb37c9687b06d7d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vodo-0.2.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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bdf29ae691fdc0bf12aa96382fb9554a1968301015cfa2aec98fc59aea7ef436
MD5 672dc8ab5dda8c3d90e4d791e3d821ea
BLAKE2b-256 23cff24a21f18a04f32b50ac29deff48e60e8ca596bfc25ff0f746256be7c652

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