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.
Release files for viur-toolkit 0.8.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| viur_toolkit-0.8.2.tar.gz | 32.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| viur_toolkit-0.8.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 68.9 kB
Release files / viur_toolkit-0.8.2.tar.gz
| Download URL | viur_toolkit-0.8.2.tar.gz |
|---|---|
| Size | 32.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
79c0a1dba78ca05e32798b067a49e91d54ae0caaba6b58b67be725afd06e9ff2
|
|
BLAKE2b-256 checksum How to use checksums |
a7dfe473cea6c154c4749259688e1adb7952ec7b2925f6d67f14c5ec1e4a2437
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / viur_toolkit-0.8.2-py3-none-any.whl
| Download URL | viur_toolkit-0.8.2-py3-none-any.whl |
|---|---|
| Size | 36.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
214a80e0557696d6644442f48297eaca99ab599a1f776c529ccc06e5e60cd020
|
|
BLAKE2b-256 checksum How to use checksums |
8a0ac83744e0706d730c09146d2bc834fd0c24cc4e825775701a59a33ba7cd82
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
