Skip to main content

A simple CLI for Vikunja task manager

Project description

CLI client for Vikunja

This is a simple cli for Vikunja, written in python.

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

The todo app to organize your life.

Installation

  • 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 Vikunja server.
  • Install from pypi:
    pip install vja
    vja --help
    

Usage

vja --help
vja ls

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

More on Features.md

Development

Prepare python virtual 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.

pip install -r requirements_dev.txt
pip uninstall -y vja;rm -rf build dist vja.egg-info; python setup.py sdist bdist_wheel; pip install dist/*.whl;
test/integration/run.sh start test/integration/docker-compose.yml

Upload to pypi

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

Project details


Release history Release notifications | RSS feed

This version

0.1.1

Download files

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

Source Distribution

vja-0.1.1.tar.gz (22.8 kB view details)

Uploaded Source

Built Distribution

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

vja-0.1.1-py3-none-any.whl (24.3 kB view details)

Uploaded Python 3

File details

Details for the file vja-0.1.1.tar.gz.

File metadata

  • Download URL: vja-0.1.1.tar.gz
  • Upload date:
  • Size: 22.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.12

File hashes

Hashes for vja-0.1.1.tar.gz
Algorithm Hash digest
SHA256 8531ea13c0227cfb885fb3c12f6d23106bfbe5a0fe9440bdb1af9a083750cff8
MD5 2ff366fa7531a8013f4311c154318980
BLAKE2b-256 456b8cf4a62bf7999cf898308e98d1d65099b859a5d8129fd75a70b495f42e80

See more details on using hashes here.

File details

Details for the file vja-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: vja-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 24.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.12

File hashes

Hashes for vja-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 df16ee5a40151bba4673c637e0a1ddface61a7956b70371a1effe3dc9075271c
MD5 80dc0a8711451677d20491cf73b1d972
BLAKE2b-256 e4656968067a404ade3fde6a3adb41ad264995926f6be610bede4f2dcdfbc237

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