Couchbase Adapter for PyCasbin
====
Couchbase storage adapter for PyCasbin
## Installation
```
pip install casbin_couchbase_adapter
# Create secondary index in Couchbase to support N1QL queries
CREATE INDEX idx_casbin ON content(meta().id, ptype) WHERE meta().id LIKE "casbin_rule%"
```
## Simple Example
```python
import casbin_couchbase_adapter
import casbin
adapter = casbin_couchbase_adapter.Adapter('couchbase://localhost:8091', 'bucket', 'user', 'password')
e = casbin.Enforcer('path/to/model.conf', adapter, True)
sub = "alice" # the user that wants to access a resource.
obj = "data1" # the resource that is going to be accessed.
act = "read" # the operation that the user performs on the resource.
if e.enforce(sub, obj, act):
# permit alice to read data1
pass
else:
# deny the request, show an error
pass
```
## Development
1. Fork
2. Install Dev ENV
```python
# Install Flask-Casbin with Dev packages
pip install -r dev_requirements.txt
pip install -r requirements.txt
pip install -e .
# Install Pre-commits
pre-commit install
# Create feature branch
git checkout -b feature-more-cool-stuff
# Code stuff
```
Then push your changes and create a PR
#### Manually Bump Version
```
bumpversion major # major release
or
bumpversion minor # minor release
or
bumpversion patch # hotfix release
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ScienceLogic/casbin-couchbase-adapter",
"name": "casbin-couchbase-adapter",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": null,
"keywords": "casbin, Couchbase, casbin-adapter, rbac, access control, abac, acl, permission",
"author": "ScienceLogic",
"author_email": null,
"download_url": null,
"platform": null,
"description": "Couchbase Adapter for PyCasbin \n====\n\nCouchbase storage adapter for PyCasbin\n\n## Installation\n\n```\npip install casbin_couchbase_adapter\n\n# Create secondary index in Couchbase to support N1QL queries\nCREATE INDEX idx_casbin ON content(meta().id, ptype) WHERE meta().id LIKE \"casbin_rule%\"\n```\n\n\n## Simple Example\n\n```python\nimport casbin_couchbase_adapter\nimport casbin\n\nadapter = casbin_couchbase_adapter.Adapter('couchbase://localhost:8091', 'bucket', 'user', 'password')\n\ne = casbin.Enforcer('path/to/model.conf', adapter, True)\n\nsub = \"alice\" # the user that wants to access a resource.\nobj = \"data1\" # the resource that is going to be accessed.\nact = \"read\" # the operation that the user performs on the resource.\n\nif e.enforce(sub, obj, act):\n # permit alice to read data1\n pass\nelse:\n # deny the request, show an error\n pass\n```\n\n## Development\n\n1. Fork\n2. Install Dev ENV\n```python\n# Install Flask-Casbin with Dev packages\npip install -r dev_requirements.txt\npip install -r requirements.txt\npip install -e .\n# Install Pre-commits\npre-commit install\n# Create feature branch\ngit checkout -b feature-more-cool-stuff\n# Code stuff\n```\nThen push your changes and create a PR\n\n#### Manually Bump Version\n```\nbumpversion major # major release\nor\nbumpversion minor # minor release\nor\nbumpversion patch # hotfix release\n```\n",
"bugtrack_url": null,
"license": "Apache2",
"summary": "Couchbase Adapter for PyCasbin",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/ScienceLogic/casbin-couchbase-adapter"
},
"split_keywords": [
"casbin",
" couchbase",
" casbin-adapter",
" rbac",
" access control",
" abac",
" acl",
" permission"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bffa61272a4a4cddbe615496f443c0cbd4bf783232b150cc09dfc855df4da23b",
"md5": "a78a34f9d7bde699f31652d35d33a465",
"sha256": "2890b87210f3dd916d3505797d7a87b86360039b17300f2a2249e436660dada2"
},
"downloads": -1,
"filename": "casbin_couchbase_adapter-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a78a34f9d7bde699f31652d35d33a465",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5",
"size": 5488,
"upload_time": "2024-11-19T17:22:06",
"upload_time_iso_8601": "2024-11-19T17:22:06.879293Z",
"url": "https://files.pythonhosted.org/packages/bf/fa/61272a4a4cddbe615496f443c0cbd4bf783232b150cc09dfc855df4da23b/casbin_couchbase_adapter-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-19 17:22:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ScienceLogic",
"github_project": "casbin-couchbase-adapter",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "casbin-couchbase-adapter"
}
JSON
