Skip to main content

Flask Cloud NDB: Adds Google Cloud NDB support to Flask

Project description

Flask-Cloud-NDB is an extension for Flask that adds support for Google Cloud NDB to your application.

Installing

Install and update using pip:

$ pip install -U Flask-Cloud-NDB

A Simple Example

from flask import Flask
from google.cloud import ndb
from flask_cloud_ndb import CloudNDB

app = Flask(__name__)
cloud_ndb = CloudNDB(app)


class Note(ndb.Model):
    title = ndb.StringProperty()
    content = ndb.StringProperty()
    created_at = ndb.DateTimeProperty()


@app.route('/')
def index():
    Note(
        title="Flask Cloud NDB with request",
        content="This is an extension, and here is an example"
        " of how to use within a request").put()

    notes = Note.query().fetch()

    return notes[0].title


# we can also simply use the context wrapper:
with cloud_ndb.context():
    Note(
        title="Flask Cloud NDB without request",
        content="This is an extension, and here is an example "
        "of how to use without request").put()
    notes = Note.query().fetch()
    print(notes[0].title)


if __name__ == '__main__':
    app.run()

Configuration Options

By default the extension will run by itself in the cloud, without any additional configurations, using the default app engine credentials.

TODOS

  • Add full configuration options description in readme
  • Add black formatting
  • Add more links to readme
  • Add more documentation to code
  • Add changes file
  • Complete manifest.in file
  • Complete setup.cfg file
  • Add tests!!
  • Add coverage
  • Build distribution for pypi

Download files

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

Files for Flask-Cloud-NDB, version 0.2.0
Filename, size File type Python version Upload date Hashes
Filename, size Flask_Cloud_NDB-0.2.0-py3-none-any.whl (4.3 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page