Merge pull request #41 from invertase/flask_https_example

chore: add sample for Https functions & Flask

Author: taeold

samples/https_flask/.firebaserc

@@ -0,0 +1,5 @@
+{
+  "projects": {
+    "default": "python-functions-testing"
+  }
+}

samples/https_flask/.gitignore

@@ -0,0 +1,66 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+firebase-debug.log*
+firebase-debug.*.log*
+
+# Firebase cache
+.firebase/
+
+# Firebase config
+
+# Uncomment this if you'd like others to create their own Firebase project.
+# For a team working on the same Firebase project(s), it is recommended to leave
+# it commented so all members can deploy to the same project(s) in .firebaserc.
+# .firebaserc
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env

samples/https_flask/__init__.py

@@ -0,0 +1,3 @@
+# Required to avoid a 'duplicate modules' mypy error
+# in monorepos that have multiple main.py files.
+# https://github.com/python/mypy/issues/4008

samples/https_flask/firebase.json

@@ -0,0 +1,11 @@
+{
+  "functions": [
+    {
+      "source": "functions",
+      "codebase": "default",
+      "ignore": [
+        "venv"
+      ]
+    }
+  ]
+}

samples/https_flask/functions/.gitignore

@@ -0,0 +1,13 @@
+# pyenv
+.python-version
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Environments
+.env
+.venv
+venv/
+venv.bak/
+__pycache__

samples/https_flask/functions/README.md

@@ -0,0 +1,10 @@
+# Flask & Firebase Functions Example
+
+Getting started locally:
+
+```bash
+python3.10 -m venv venv
+source venv/bin/activate
+pip3 install --upgrade pip
+python3.10 -m pip install -r requirements.txt
+```

samples/https_flask/functions/main.py

@@ -0,0 +1,25 @@
+"""
+Example Firebase Functions with Flask.
+"""
+
+from flask import Flask
+from functions_wrapper import entrypoint
+
+from firebase_functions import https_fn
+
+app = Flask(__name__)
+
+
+@app.route("/hello")
+def hello():
+    return "Hello!"
+
+
+@app.route("/world")
+def world():
+    return "Hello World!"
+
+
+@https_fn.on_request()
+def httpsflaskexample(request):
+    return entrypoint(app, request)

samples/https_flask/functions/requirements.txt

@@ -0,0 +1,9 @@
+# Not published yet,
+# firebase-functions-python >= 0.0.1
+# so we use a relative path during development:
+# ./../../../
+# Or switch to git ref for deployment testing:
+git+https://github.com/firebase/firebase-functions-python.git@main#egg=firebase-functions
+
+firebase-admin >= 6.0.1
+functions_wrapper >= 1.0.1