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 / Contributing
Create a fork and clone it
Setup the local environment with pipenv:
cd viur-toolkit
pipenv install --dev
pipenv run precommit_install
Install as editable in your project
cd myproject
pipenv install -e path/to/viur-toolkit
Code linting & type checking
Use the lint command
$ pipenv run lint
tu run pep8check and type_check at once.
Alternative:
Setup the pre-commit hook with pipenv run precommit_install.
Branches
Depending on what kind of change your Pull Request contains, please submit your PR against the following branches:
- main: fixes/patches that fix a problem with existing code go into this branch. This results in a new patch version (X.X.n+1 where n is the current patch-level).
- develop: new features, refactorings, or adjustments for new versions of dependencies are added to this branch. This becomes a new minor version (X.n+1.0) where n is the current minor-level). Depending on the complexity of the changes, a new major release (n+1.0.0, where n is the current major level) may be chosen instead.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
viur_toolkit-0.8.1.tar.gz
(32.2 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file viur_toolkit-0.8.1.tar.gz.
File metadata
- Download URL: viur_toolkit-0.8.1.tar.gz
- Upload date:
- Size: 32.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
44bf25eee989173a3671e98fa7dc96c69fca62ee2e3eabc43140366a5a681441
|
|
| MD5 |
638b78d03175a98b8f932598e3907d4b
|
|
| BLAKE2b-256 |
2b9d3a140da813e9ce9a75b11f0425430fa47e169601605af6612f7caeb82e43
|
File details
Details for the file viur_toolkit-0.8.1-py3-none-any.whl.
File metadata
- Download URL: viur_toolkit-0.8.1-py3-none-any.whl
- Upload date:
- Size: 35.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fb58ca53281ff4aeaca67473c160406862b08a667c5679717cf13d5c1e454da6
|
|
| MD5 |
9cb2aef867fcc0087b858024f9fa43ea
|
|
| BLAKE2b-256 |
ed9019b3a4b114bf6f9f1838e0776455de76dd5d7dc91037fec18520d2a93a12
|
