CLI client for Vikunja

This is a simple CLI for Vikunja > The todo app to organize your life.

It provides a command line interface for adding, viewing and editing todo tasks on a Vikunja Server. The goal is to support a command line based task workflow ~ similar to taskwarrior.

Installation

• Install from pypi:

  pip install vja
  vja --help
  

• Upgrade existing version:

  pip install vja --upgrade
  

Configuration

Before using vja you must provide a configuration.

• Create a configuration file $HOME/.vjacli/vja.rc with ~ the following contents

  [application]
  frontend_url=https://try.vikunja.io/
  api_url=https://try.vikunja.io/api/v1
  

  (If you cloned from git, you may copy the folder .vjacli to your $HOME directory instead.)
• Adjust to your needs.
  frontend_url and api_url must point to your own Vikunja server.
  Especially, the api_url must be reachable from your client. This can be verified, for example by curl https://mydomain.com/api/v1/info

Usage

vja --help
vja ls

(You will be prompted for your account on first usage and any time the access token expires.)

More documentation is available on Features.md

Development

Prepare python virtual environment

Python >= 3.8 is recommended. First create a local environment:

pip install virtualenv
virtualenv venv
source venv/bin/activate

Local build

Build, install and perform some integration-test. For integration test, a real Vikunja instance is launched locally via docker-compose. Local development install:

pip install -r requirements_dev.txt
pip install -e . 

Alternatively: full local installation:

# pip uninstall -y vja;rm -rf build dist vja.egg-info; python setup.py sdist bdist_wheel; pip install dist/*.whl;

Run integration test (requires docker and docker-compose)

docker-compose -f tests/docker-compose.yml up -d
./run.sh
VJA_CONFIGDIR=tests/.vjatest pytest
docker-compose -f tests/docker-compose.yml down