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 Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

vodo-0.1.0-py3-none-any.whl (7.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for vodo-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 aec197842e72f8e4c6f6277fe4b277383ac6d24c4b2fe9e51b64baf0757be4e1
MD5 33179200c2790f8e126bc1d935ce9e86
BLAKE2b-256 5f8745311ed21bfe15dca786997d3cf9191ddf5c59fec66efdf4337189fc3f95

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