Skip to main content

Adds SQLAlchemy support to a Flask-Smorest REST API

Project description

Flask REST API without the cruft

This packages builds upon flask-smorest and SQLAlchemy, to provide ORM integration and a boilerplate-free REST implementation with:

  • CRUD endpoints

  • [To do] Access Authorisation

  • [To do] Authentication

Install

pip install flask-smorest-sql

Quickstart

With a Flask-Smorest api object registered:

class Test(db.Model):
    """Test model."""
    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String(128))

with app.app_context():
    db.create_all()

bp = CRUDBlueprint("Test", __name__, db=db, url_prefix="/test", model_class=TestModel)
api.register_blueprint(bp)

Will create all CRUD endpoints for resource Test at URL /test.

Documentation

Full documentation is available at http://flask-smorest-sqla.readthedocs.io/.

License

MIT licensed. See the LICENSE file for more details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flask_smorest_sqla-0.2.2.tar.gz (4.5 kB view hashes)

Uploaded Source

Built Distribution

flask_smorest_sqla-0.2.2-py3-none-any.whl (6.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page