{"id":20114345,"url":"https://github.com/jetbridge/smorest-crud","last_synced_at":"2025-05-06T12:30:58.424Z","repository":{"id":54846612,"uuid":"239790718","full_name":"jetbridge/smorest-crud","owner":"jetbridge","description":"CRUD for Flask-Smorest (SQLAlchemy, Marshmallow). Eliminate boilerplate.","archived":false,"fork":false,"pushed_at":"2021-04-12T15:17:06.000Z","size":201,"stargazers_count":12,"open_issues_count":0,"forks_count":1,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-04-19T00:14:17.465Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/jetbridge.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}},"created_at":"2020-02-11T15:05:48.000Z","updated_at":"2024-04-06T08:15:52.000Z","dependencies_parsed_at":"2022-08-14T04:40:23.125Z","dependency_job_id":null,"html_url":"https://github.com/jetbridge/smorest-crud","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jetbridge%2Fsmorest-crud","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jetbridge%2Fsmorest-crud/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jetbridge%2Fsmorest-crud/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jetbridge%2Fsmorest-crud/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jetbridge","download_url":"https://codeload.github.com/jetbridge/smorest-crud/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252683431,"owners_count":21788039,"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":[],"created_at":"2024-11-13T18:29:24.707Z","updated_at":"2025-05-06T12:30:58.166Z","avatar_url":"https://github.com/jetbridge.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Documentation Status](https://readthedocs.org/projects/smorest-crud/badge/?version=latest)](https://smorest-crud.readthedocs.io/en/latest/?badge=latest)\n\n# Flask Smorest CRUD\n_Why repeat yourself?_\n\nThis library aims to tie together Flask-SQLAlchemy and Flask-Smorest to implement a sane default but easily customizable CRUD API based on SQLAlchemy models inside of Flask.\n\n# Quickstart\nIn `create_app()`:\n```python\nfrom smorest_crud import CRUD\nfrom flask_jwt_extended import JWTManager, get_current_user\n\napp = Flask()\nJWTManager(app)\nCRUD(app)\n\napp.config.update(\n    CRUD_GET_USER=get_current_user,\n    CRUD_ACCESS_CHECKS_ENABLED=True,\n    SECRET_KEY=\"wnt2die\",\n)\n```\n\nCRUD View:\n```python\nfrom flask_smorest import Blueprint\nfrom smorest_crud import ResourceView, CollectionView\n\npet_blp = Blueprint(\"pets\", \"pets\", url_prefix=\"/pet\")\n\n\n@pet_blp.route(\"\")\nclass PetCollection(CollectionView):\n    model = Pet\n    prefetch = [Pet.human, (Pet.human, Human.cars)]  # joinedload\n    access_checks_enabled = False\n\n    create_enabled = True\n    list_enabled = True\n\n    @pet_blp.response(PetSchema(many=True))\n    def get(self):\n        \"\"\"List pets.\"\"\"\n        query = super().get()\n        return query.filter_by(name='mischa')\n\n    @pet_blp.arguments(PetSchema)\n    @pet_blp.response(PetSchema(many=True))\n    def post(self, args):\n        \"\"\"Create a pet.\"\"\"\n        return super().post(args)\n\n\n@pet_blp.route(\"/\u003cint:pk\u003e\")\nclass PetResource(ResourceView):\n    model = Pet\n\n    access_checks_enabled = True\n    get_enabled = True\n    update_enabled = True\n    delete_enabled = True\n\n    @pet_blp.response(PetSchema)\n    def get(self, pk):\n        return super().get(pk)\n\n    @pet_blp.arguments(PetSchema)\n    @pet_blp.response(PetSchema)\n    def patch(self, args, pk):\n        return super().patch(args, pk)\n\n    @pet_blp.response(PetSchema)\n    def delete(self, pk):\n        return super().delete(pk)\n```\n\n# Who is this for?\nThis library is only useful if your application uses:\n* [Flask-Smorest](https://flask-smorest.readthedocs.io/en/stable/)\n* [Flask-SQLAlchemy](https://flask-sqlalchemy.palletsprojects.com/)\n* [Flask-JWT-Extended](https://flask-jwt-extended.readthedocs.io/en/stable/)\n\n\n# Where to look?\nLook at `smorest_crud/test/app.py`\n\n\nFeedback and comments welcome. What would you like to see? Open an issue or a PR with your thoughts.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjetbridge%2Fsmorest-crud","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjetbridge%2Fsmorest-crud","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjetbridge%2Fsmorest-crud/lists"}