{"id":18020669,"url":"https://github.com/acifani/flask-sqla2api","last_synced_at":"2025-03-26T21:32:23.001Z","repository":{"id":28726418,"uuid":"104778696","full_name":"acifani/flask-sqla2api","owner":"acifani","description":"⚗️ SQLAlchemy Model to API in one line of code","archived":false,"fork":false,"pushed_at":"2022-05-01T04:15:19.000Z","size":100,"stargazers_count":10,"open_issues_count":4,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-16T16:47:23.590Z","etag":null,"topics":["flask","flask-extensions","flask-sqlalchemy","python"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/Flask-SQLA2api/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/acifani.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGES.rst","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":"2017-09-25T17:08:41.000Z","updated_at":"2024-03-17T13:46:01.000Z","dependencies_parsed_at":"2022-08-08T04:15:12.695Z","dependency_job_id":null,"html_url":"https://github.com/acifani/flask-sqla2api","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acifani%2Fflask-sqla2api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acifani%2Fflask-sqla2api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acifani%2Fflask-sqla2api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acifani%2Fflask-sqla2api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/acifani","download_url":"https://codeload.github.com/acifani/flask-sqla2api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245738913,"owners_count":20664369,"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":["flask","flask-extensions","flask-sqlalchemy","python"],"created_at":"2024-10-30T06:07:04.245Z","updated_at":"2025-03-26T21:32:17.982Z","avatar_url":"https://github.com/acifani.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Flask-SQLA2api\n==============\n\n.. image:: https://travis-ci.org/acifani/flask-sqla2api.svg?branch=master\n    :target: https://travis-ci.org/acifani/flask-sqla2api\n\n.. image:: https://badge.fury.io/py/Flask-SQLA2api.svg\n    :target: https://badge.fury.io/py/Flask-SQLA2api\n\n.. image:: https://coveralls.io/repos/github/acifani/flask-sqla2api/badge.svg?branch=master\n    :target: https://coveralls.io/github/acifani/flask-sqla2api?branch=master\n\n\nFlask middleware that creates a simple Flask API CRUD REST endpoint\nbased on a SQLAlchemy model definition.\n\nBasic usage\n-----------\n\n.. code-block:: python\n\n    from flask import Flask\n    from flask_sqlalchemy import SQLAlchemy\n    from flask_sqla2api import SQLA2api\n\n    # Init app and DB\n    app = Flask(__name__)\n    db = SQLAlchemy(app)\n\n    # Setup a simple SQLAlchemy model\n    class Entry(db.Model):\n        id = db.Column(db.Integer, primary_key=True)\n        name = db.Column(db.String(80))\n\n    # Init Flask-sqla2api\n    api = SQLA2api([Entry], self.db)\n    api.append_blueprints(app)\n\nThe previous tiny app will create the following endpoints\n\n===============  =========== =======================\nURL              HTTP Method Action\n===============  =========== =======================\n``/entry``       GET         Get all entries\n``/entry``       POST        Create new entry\n``/entry/\u003cid\u003e``  GET         Get a single entry\n``/entry/\u003cid\u003e``  PUT         Edit existing entry\n``/entry/\u003cid\u003e``  DELETE      Delete existing entry\n===============  =========== =======================\n\nGenerate single blueprint\n-------------------------\n\nIf you want more control over your blueprints you can generate it\nand append it yourself to your app.\n\n.. code-block:: python\n\n    from flask import Flask\n    from flask_sqlalchemy import SQLAlchemy\n    from flask_sqla2api import generate_blueprint\n\n    # Init app and DB\n    app = Flask(__name__)\n    db = SQLAlchemy(app)\n\n    # Setup a simple SQLAlchemy model\n    class Entry(db.Model):\n        id = db.Column(db.Integer, primary_key=True)\n        name = db.Column(db.String(80))\n\n    # Generate and register blueprint\n    blueprint = generate_blueprint(Entry, db)\n    app.register_blueprint(blueprint, url_endpoint='/')\n\nTo-Do\n-----\n\n- Input validation\n- API docs generation\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Facifani%2Fflask-sqla2api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Facifani%2Fflask-sqla2api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Facifani%2Fflask-sqla2api/lists"}