Metadata-Version: 2.1
Name: vja
Version: 1.0.5
Summary: A simple CLI for Vikunja task manager
Home-page: https://gitlab.com/ce72/vja
Author: ce72
License: UNKNOWN
Description: # CLI client for Vikunja
        
        [![pypi package version](https://img.shields.io/pypi/v/vja)](https://pypi.org/project/vja/)
        [![pypi downloads](https://img.shields.io/pypi/dw/vja)](https://pypi.org/project/vja/)
        [![pipeline status](https://gitlab.com/ce72/vja/badges/main/pipeline.svg)](https://gitlab.com/ce72/vja/-/pipelines)
        [![coverage report](https://gitlab.com/ce72/vja/badges/main/coverage.svg)](https://gitlab.com/ce72/vja/commits/main)
        
        This is a simple CLI for Vikunja > [The todo app to organize your life.](https://vikunja.io/)
        
        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:
          ```shell
          pip install vja
          vja --help
          ```
        - Upgrade existing version:
          ```shell
          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
          ```shell
          [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
        
        ```shell
        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](https://gitlab.com/ce72/vja/-/blob/main/Features.md)**
        
        ## Development
        
        ### Prepare python virtual environment
        
        Python >= 3.8 is recommended. First create a local environment:
        
        ```shell
        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:
        
        ```shell
        pip install -r requirements_dev.txt
        pip install -e . 
        ```
        
        Alternatively: full local install:
        
        ```shell
        # 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)
        
        ```shell
        docker-compose -f tests/docker-compose.yml up -d
        ./run.sh
        VJA_CONFIGDIR=tests/.vjatest pytest
        docker-compose -f tests/docker-compose.yml down
        ```
        
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Description-Content-Type: text/markdown
