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.0

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.0.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.0-py3-none-any.whl (24.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vja-0.1.0.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.0.tar.gz
Algorithm Hash digest
SHA256 d39cf3be71e578cfdbf6fd3b3e2fc3828ab2b0d16645b9510a5cc80dc10c6a60
MD5 86fdd3c5c0c51cef0c7e9856076c9a70
BLAKE2b-256 bcc0962dc5f2d6a329aae20f066c499876515a7a60ad2bc4699992ed907d7024

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vja-0.1.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 72be5b8f4788bad86ff202af5fc3e69945cf2642dfd312fe93c5968907ef158f
MD5 81c72e2ed7a51350a8a04c471e8b6937
BLAKE2b-256 989782da807366a370301278b137375bee78ca5d7f57986ad0967e47988487b8

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