Package: vja
CLI client for VikunjaThis 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.Breaking changes in vja 3.0vja 3.0 supports (and requires) the most recent Vikunja API 0.22.0.
Use vja up to version 2.4.1 for compatibility with Vikunja API 0.21.0.Usagevja--help
vjals(You will be prompted for your account on first usage and any time the access token expires, seeFeatures.md)More user documentation is available onFeatures.mdInstallationInstall from pypi:python-mpipinstall--uservja
vja--helpUpgrade existing version:python-mpipinstall--uservja--upgradeConfigurationBefore 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$HOMEdirectory instead.)Adjust to your needs.frontend_urlandapi_urlmust point to your own Vikunja server.
Especially, the api_url must be reachable from your client. This can be verified, for example,
bycurl https://mydomain.com/api/v1/info.You may change the location of the configuration directory with an environment variable
likeVJA_CONFIGDIR=/not/my/homeDescription of configurationRequired optionsSectionOptionDescription[application]api_urlThe service instance of Vikunja to which vja should connect[application]frontend_urlRequired to open Vikunja in BrowserOptional optionsSectionOptionDescription[output]arbitrary_namePython format strings which may be referenced on the command line by--custom-format=<option_name>. May contain any valid python f-Format string.Take care: The format string may provide code which will be executed at runtime! Do not use--custom-formatif you are unsure.Default: missing[output]another_formatMultiple formats can be defined for reference. (see above)[urgency_coefficients]due_date_weightWeight of dueness in urgency score. Default: 1.0[urgency_coefficients]priority_weightWeight of priority in urgency score. Default: 1.0[urgency_coefficients]favorite_weightWeight of is_favorite in urgency score. Default: 1.0[urgency_coefficients]project_weightWeight of keyword occurrence in project title in urgency score. Default: 1.0[urgency_coefficients]label_weightWeight of keyword occurrence in label title in urgency score. Default: 1.0[urgency_keywords]lisproject_keywordsTasks in projects with a title containing these keywords are considered more urgent. Default: None[urgency_keywords]label_keywordsTasks labeled with one of these keywords are considered more urgent. Default: NoneDevelopmentPrepare python virtual environmentPython >= 3.8 is recommended. First create a local environment:python-mvenv./venvsourcevenv/bin/activate(That may besource venv/Scripts/activateon some windows machines.)Local buildLocal development installpython-mpipinstall-rrequirements_dev.txt
python-mpipinstall-e.Run integration testStart docker container forvikunja/api:latestand executepytestagainst that server instance.dockercompose-ftests/docker-compose.ymlup-dVJA_CONFIGDIR=tests/.vjatestpytest
dockercompose-ftests/docker-compose.ymldown