| Name | viur-toolkit JSON |
| Version |
0.2.3
JSON |
| download |
| home_page | None |
| Summary | A kit of helpers and tools to simplify more intensive use of ViUR |
| upload_time | 2024-12-06 18:29:58 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2024 ViUR Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
viur
plugin
backend
toolkit
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align="center">
<h1>viur-toolkit</h1>
<a href="https://pypi.org/project/viur-toolkit/">
<img alt="Badge showing current PyPI version" title="PyPI" src="https://img.shields.io/pypi/v/viur-toolkit">
</a>
<a href="LICENSE">
<img src="https://img.shields.io/github/license/viur-framework/viur-toolkit" alt="Badge displaying the license" title="License badge">
</a>
<br>
A kit of helpers and tools to simplify more intensive use of ViUR
</div>
## 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "viur-toolkit",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Sven Eberth <se@mausbrand.de>",
"keywords": "viur, plugin, backend, toolkit",
"author": null,
"author_email": "Sven Eberth <se@mausbrand.de>",
"download_url": "https://files.pythonhosted.org/packages/65/3d/bbf41f0d573ee2d0af43c07977b8bca8b71ec0bbc7f80bc3b8c8e1b6564e/viur_toolkit-0.2.3.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n <h1>viur-toolkit</h1>\n <a href=\"https://pypi.org/project/viur-toolkit/\">\n <img alt=\"Badge showing current PyPI version\" title=\"PyPI\" src=\"https://img.shields.io/pypi/v/viur-toolkit\">\n </a>\n <a href=\"LICENSE\">\n <img src=\"https://img.shields.io/github/license/viur-framework/viur-toolkit\" alt=\"Badge displaying the license\" title=\"License badge\">\n </a>\n <br>\n A kit of helpers and tools to simplify more intensive use of ViUR\n</div>\n\n## Usage\n\n### Install with pip\n```\npip install viur-toolkit\n```\n\n### Install with pipenv\n```\npipenv install viur-toolkit\n```\n\n### Example\n```python\nfrom viur import toolkit\n\nif toolkit.user_has_access(\"root\"):\n print(\"Hello root user!\")\n```\n\n\n## Development / Contributing\n\nCreate a fork and clone it\n\n### Setup the local environment with pipenv:\n```sh\ncd viur-toolkit\npipenv install --dev\npipenv run precommit_install\n```\n\n### Install as editable in your project\n```sh\ncd myproject\npipenv install -e path/to/viur-toolkit\n```\n\n### Code linting & type checking\nUse the `lint` command\n```sh\n$ pipenv run lint\n```\ntu run `pep8check` and `type_check` at once.\n\n#### Alternative:\nSetup the pre-commit hook with `pipenv run precommit_install`.\n\n### Branches\nDepending on what kind of change your Pull Request contains, please submit your PR against the following branches:\n\n* **main:**\n fixes/patches that fix a problem with existing code go into this branch.\n This results in a new patch version (X.X.n+1 where n is the current patch-level).\n* **develop:**\n new features, refactorings, or adjustments for new versions of dependencies are added to this branch.\n This becomes a new minor version (X.n+1.0) where n is the current minor-level).\n 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.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 ViUR Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "A kit of helpers and tools to simplify more intensive use of ViUR",
"version": "0.2.3",
"project_urls": {
"Bug Tracker": "https://github.com/viur-framework/viur-toolkit/issues",
"Repository": "https://github.com/viur-framework/viur-toolkit.git"
},
"split_keywords": [
"viur",
" plugin",
" backend",
" toolkit"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ef688271f77c1b3ce4b359f6c3ac81ec9b2021acc7ebb1ce91e7ce0087ced638",
"md5": "d550454285b2f4e624fffd830576d4c6",
"sha256": "bfff1d7b1c81b7b3072e65583d6d1b107b356ada15e12aaa4d15b6813c705121"
},
"downloads": -1,
"filename": "viur_toolkit-0.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d550454285b2f4e624fffd830576d4c6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 32637,
"upload_time": "2024-12-06T18:29:55",
"upload_time_iso_8601": "2024-12-06T18:29:55.990093Z",
"url": "https://files.pythonhosted.org/packages/ef/68/8271f77c1b3ce4b359f6c3ac81ec9b2021acc7ebb1ce91e7ce0087ced638/viur_toolkit-0.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "653dbbf41f0d573ee2d0af43c07977b8bca8b71ec0bbc7f80bc3b8c8e1b6564e",
"md5": "3a387d5ba792134beb3b6115703a1fd1",
"sha256": "478e9cbaa8b487c36764400ff30e0615b1598bf86e9c329c33cd3dbccf14a3cb"
},
"downloads": -1,
"filename": "viur_toolkit-0.2.3.tar.gz",
"has_sig": false,
"md5_digest": "3a387d5ba792134beb3b6115703a1fd1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 28989,
"upload_time": "2024-12-06T18:29:58",
"upload_time_iso_8601": "2024-12-06T18:29:58.263606Z",
"url": "https://files.pythonhosted.org/packages/65/3d/bbf41f0d573ee2d0af43c07977b8bca8b71ec0bbc7f80bc3b8c8e1b6564e/viur_toolkit-0.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-06 18:29:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "viur-framework",
"github_project": "viur-toolkit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "viur-toolkit"
}
