{"id":13340536,"url":"https://github.com/viur-framework/viur-toolkit","last_synced_at":"2026-01-16T07:40:00.872Z","repository":{"id":226246485,"uuid":"768188368","full_name":"viur-framework/viur-toolkit","owner":"viur-framework","description":"A kit of helpers and tools to simplify more intensive use of ViUR","archived":false,"fork":false,"pushed_at":"2025-03-13T10:03:47.000Z","size":204,"stargazers_count":4,"open_issues_count":4,"forks_count":2,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-04-11T19:58:00.571Z","etag":null,"topics":["helpers","toolkit","viur"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/viur-framework.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-06T16:21:55.000Z","updated_at":"2025-03-13T10:03:51.000Z","dependencies_parsed_at":"2024-04-22T13:38:06.585Z","dependency_job_id":"e484fc9d-e0dc-49a9-99f0-60d0cb5e9beb","html_url":"https://github.com/viur-framework/viur-toolkit","commit_stats":null,"previous_names":["viur-framework/viur-toolkit"],"tags_count":30,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viur-framework%2Fviur-toolkit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viur-framework%2Fviur-toolkit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viur-framework%2Fviur-toolkit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viur-framework%2Fviur-toolkit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/viur-framework","download_url":"https://codeload.github.com/viur-framework/viur-toolkit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248752341,"owners_count":21156075,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["helpers","toolkit","viur"],"created_at":"2024-07-29T19:23:32.718Z","updated_at":"2026-01-16T07:40:00.857Z","avatar_url":"https://github.com/viur-framework.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"https://github.com/viur-framework/viur-artwork/raw/main/icons/icon-toolkit.svg\" height=\"196\" alt=\"A hexagonal logo of Toolkit\" title=\"Toolkit logo\"/\u003e\n    \u003ch1\u003eviur-toolkit\u003c/h1\u003e\n    \u003ca href=\"https://pypi.org/project/viur-toolkit/\"\u003e\n        \u003cimg alt=\"Badge showing current PyPI version\" title=\"PyPI\" src=\"https://img.shields.io/pypi/v/viur-toolkit\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"LICENSE\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/license/viur-framework/viur-toolkit\" alt=\"Badge displaying the license\" title=\"License badge\"\u003e\n    \u003c/a\u003e\n    \u003cbr\u003e\n    A kit of helpers and tools to simplify more intensive use of ViUR\n\u003c/div\u003e\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 \u0026 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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fviur-framework%2Fviur-toolkit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fviur-framework%2Fviur-toolkit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fviur-framework%2Fviur-toolkit/lists"}