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


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

vja-0.1.5-py3-none-any.whl (25.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page