https://github.com/viur-framework/viur-toolkit
A kit of helpers and tools to simplify more intensive use of ViUR
https://github.com/viur-framework/viur-toolkit
helpers toolkit viur
Last synced: 7 months ago
JSON representation
A kit of helpers and tools to simplify more intensive use of ViUR
- Host: GitHub
- URL: https://github.com/viur-framework/viur-toolkit
- Owner: viur-framework
- License: mit
- Created: 2024-03-06T16:21:55.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-13T10:03:47.000Z (over 1 year ago)
- Last Synced: 2025-04-11T19:58:00.571Z (over 1 year ago)
- Topics: helpers, toolkit, viur
- Language: Python
- Homepage:
- Size: 199 KB
- Stars: 4
- Watchers: 7
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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
```python
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:
```sh
cd viur-toolkit
pipenv install --dev
pipenv run precommit_install
```
### Install as editable in your project
```sh
cd myproject
pipenv install -e path/to/viur-toolkit
```
### Code linting & type checking
Use the `lint` command
```sh
$ 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.