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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file flask_smorest_sqla-0.2.2.tar.gz.

File metadata

  • Download URL: flask_smorest_sqla-0.2.2.tar.gz
  • Upload date:
  • Size: 4.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for flask_smorest_sqla-0.2.2.tar.gz
Algorithm Hash digest
SHA256 cec18c2dbecb53f773a0aebe62be404314ec46204854839cb9d1d007ae0b9291
MD5 f68fd93ddf870b5fdfda93c685a46362
BLAKE2b-256 e1f5b62cac3a550364afbb1ddb88d9f97e33b8730ac6371893eacab9459dcb63

See more details on using hashes here.

File details

Details for the file flask_smorest_sqla-0.2.2-py3-none-any.whl.

File metadata

File hashes

Hashes for flask_smorest_sqla-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ef7790ac682dcc38926a5d12a246c75a62beed19f17df45b63c1bace9b4ead37
MD5 6310fb9db390c241eb91973e21dca93b
BLAKE2b-256 fbc3866fb1a602b398c09ca96dc8b5626ba880f40bbb893946cd0a395f26e00c

See more details on using hashes here.

Supported by

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