README.md

viur-toolkit

A kit of helpers and tools to simplify more intensive use of ViUR

Usage

Install with pip

pip install viur-toolkit

Install with pipenv

pipenv install viur-toolkit

Example

from viur import toolkit

if toolkit.user_has_access("root"):
    print("Hello root user!")

Development

Create a fork and clone it

Setup the local environment with pipenv:

cd viur-toolkit
pipenv install --dev

Install as editable in your project

cd myproject
pipenv install -e path/to/viur-toolkit

Code linting & type checking

And use the lint command

$ pipenv run lint

tu run pep8check and type_check at once.