# Django Graphene CRUD Generator
## Installation
```
pip install graphi-crud
```
## Usage
```
import graphene
from graphi_crud.queries import Queries
from graphi_crud.create_mutation import CreateMutation
from graphi_crud.update_mutation import UpdateMutation
from graphi_crud.delete_mutation import DeleteMutation
Queries.generate_queries(["accounts"])
CreateMutation.generate_mutations(['accounts'])
UpdateMutation.generate_mutations(['accounts'])
DeleteMutation.generate_mutations(['accounts'])
class Query(Queries):
pass
class Mutation(CreateMutation, UpdateMutation, DeleteMutation):
pass
schema = graphene.Schema(query=Query, mutation=Mutation)
```
register your `schema` in settings and your good to go
## writing Queries
```
{
user(where: {email: {icontains: "user"}}, offset: 10, limit: 10){
id
email
}
}
```
## create mutation example
```
mutation{
createUser(inputs: {email: "user@gmail.com", username: "newuser"}){
data{
id
email
}
}
}
```
## update mutation example
```
mutation{
updateUser(inputs: {lastLogin: "2023-12-12"}, where: {email: {icontains: "someuser"}}){
affectedRows
data {
id
username
}
}
}
```
## delete mutation examples
```
mutation{
deleteUser(where: {email: {icontains: "someuser"}}){
affectedRows
}
}
```
## permissions
add `graphql_permissions` attribute on your model class with a list of permissions
example:
```
class Employee(models.Model):
...fields...
graphql_permissions = ['accounts.add_employee', 'accounts.change_employee']
```
Raw data
{
"_id": null,
"home_page": "https://github.com/abelayalew/graphi",
"name": "graphi_crud",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": null,
"author": "abelayalew",
"author_email": "abelayalew81@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/17/df/5bf5fc3cbc4174c28d76dab377421830c008736957e17ac15918a97620fb/graphi_crud-1.2.3.1.tar.gz",
"platform": null,
"description": "# Django Graphene CRUD Generator\n\n## Installation\n```\npip install graphi-crud\n```\n\n## Usage\n\n```\nimport graphene\nfrom graphi_crud.queries import Queries\nfrom graphi_crud.create_mutation import CreateMutation\nfrom graphi_crud.update_mutation import UpdateMutation\nfrom graphi_crud.delete_mutation import DeleteMutation\n\n\nQueries.generate_queries([\"accounts\"])\nCreateMutation.generate_mutations(['accounts'])\nUpdateMutation.generate_mutations(['accounts'])\nDeleteMutation.generate_mutations(['accounts'])\n\nclass Query(Queries):\n pass\n\nclass Mutation(CreateMutation, UpdateMutation, DeleteMutation):\n pass\n\n\nschema = graphene.Schema(query=Query, mutation=Mutation)\n\n```\n\nregister your `schema` in settings and your good to go\n\n## writing Queries\n\n```\n{\n user(where: {email: {icontains: \"user\"}}, offset: 10, limit: 10){\n id\n email\n }\n}\n```\n\n## create mutation example\n\n```\nmutation{\n createUser(inputs: {email: \"user@gmail.com\", username: \"newuser\"}){\n data{\n id\n email\n }\n }\n}\n```\n\n## update mutation example\n\n```\nmutation{\n updateUser(inputs: {lastLogin: \"2023-12-12\"}, where: {email: {icontains: \"someuser\"}}){\n affectedRows\n data {\n id\n username\n }\n }\n}\n```\n\n## delete mutation examples\n\n```\nmutation{\n deleteUser(where: {email: {icontains: \"someuser\"}}){\n affectedRows\n }\n}\n```\n\n## permissions\nadd `graphql_permissions` attribute on your model class with a list of permissions\nexample:\n``` \n class Employee(models.Model):\n ...fields...\n graphql_permissions = ['accounts.add_employee', 'accounts.change_employee']\n```",
"bugtrack_url": null,
"license": "MIT",
"summary": "Graphene Dajngo CRUD generator",
"version": "1.2.3.1",
"project_urls": {
"Homepage": "https://github.com/abelayalew/graphi",
"Repository": "https://github.com/abelayalew/graphi"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c6d5b8a89270c6d52328929b3d07d2704d89354f930f7cde1ef7bf1c8549ee45",
"md5": "c8197f1461a08f808d31635d7353b0fa",
"sha256": "d6c0865dad5dda93e093e4aced090138f6c14e3329eec2331eb69c7ee13f5b8c"
},
"downloads": -1,
"filename": "graphi_crud-1.2.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c8197f1461a08f808d31635d7353b0fa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 9797,
"upload_time": "2024-07-22T07:56:27",
"upload_time_iso_8601": "2024-07-22T07:56:27.282164Z",
"url": "https://files.pythonhosted.org/packages/c6/d5/b8a89270c6d52328929b3d07d2704d89354f930f7cde1ef7bf1c8549ee45/graphi_crud-1.2.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "17df5bf5fc3cbc4174c28d76dab377421830c008736957e17ac15918a97620fb",
"md5": "59eb72f0e0dab2de6ba4b6443ce4dc84",
"sha256": "1d2ebbb53194ab5c9b3130b6d42b59b8b9a444f002e3926cbd2bfaa19a6a0734"
},
"downloads": -1,
"filename": "graphi_crud-1.2.3.1.tar.gz",
"has_sig": false,
"md5_digest": "59eb72f0e0dab2de6ba4b6443ce4dc84",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 6959,
"upload_time": "2024-07-22T07:56:28",
"upload_time_iso_8601": "2024-07-22T07:56:28.720109Z",
"url": "https://files.pythonhosted.org/packages/17/df/5bf5fc3cbc4174c28d76dab377421830c008736957e17ac15918a97620fb/graphi_crud-1.2.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-22 07:56:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "abelayalew",
"github_project": "graphi",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "black",
"specs": [
[
"==",
"23.3.0"
]
]
},
{
"name": "Django",
"specs": [
[
"==",
"5.0"
]
]
},
{
"name": "django-filter",
"specs": [
[
"==",
"23.5"
]
]
},
{
"name": "graphene-django",
"specs": [
[
"==",
"3.2.0"
]
]
},
{
"name": "ipython",
"specs": [
[
"==",
"8.14.0"
]
]
},
{
"name": "pre-commit",
"specs": [
[
"==",
"3.3.3"
]
]
},
{
"name": "prospector",
"specs": [
[
"==",
"1.10.2"
]
]
},
{
"name": "python-decouple",
"specs": [
[
"==",
"3.7"
]
]
},
{
"name": "django-cors-headers",
"specs": [
[
"==",
"4.3.1"
]
]
}
],
"lcname": "graphi_crud"
}
JSON
