Using no dependency
Just serve the current gunicorn ... frappe.app:application setup and write a whitelisted function. It will serve ALL ERPNext ReST API. Function and response cannot be isolated.
Using FastAPI
FastAPI using Frappe Framework
Use example to build serverless function using frappe framework.
Use any framework or library of your choice instead of FastAPI.
Prerequisites
- Core development happens with standard
bench start. - Already running
frappe-benchlike setup. - Connection to same mariadb, redis that the
frappe-benchconnects to. - Access to
sitesdirectory of thefrappe-bench - Valid site to set it as
SITE_NAMEenvironment variable.
Installation
Install as python app in frappe-bench python env
cd ~/frappe-bench
git clone https://github.com/castlecraft/fast_frappe apps/fast_frappe
./env/bin/pip install -e apps/fast_frappe
Serve
Using uvicorn
cd ~/frappe-bench
. ./env/bin/activate
# Execute app from sites directory
cd ~/frappe-bench/sites
# Set SITE_NAME to use for the function
SITE_NAME=function.local uvicorn fast_frappe.main:app --port 3000
Check Response
curl -s http://localhost:3000 | jq .
Containerized
Build
cd ~/frappe-bench/apps/fast_frappe
docker build -t fast_frappe:latest .
Run
docker run -v /path/to/sites:/home/frappe/frappe-bench/sites --publish 3000:3000 fast_frappe:latest
Description
The app consists of 2 files:
main.py:
import frappe
from typing import Optional
from fastapi import FastAPI
from fast_frappe.ctrl import init_frappe, destroy_frappe
app = FastAPI()
@app.get("/")
def read_root():
init_frappe()
available_doctypes = frappe.get_list("DocType")
settings = frappe.get_single("System Settings")
destroy_frappe()
return {
"available_doctypes": available_doctypes,
"settings": settings.as_dict(),
}
and ctrl.py:
import os
import frappe
def init_frappe():
site = os.environ.get("SITE_NAME", "test.localhost")
frappe.init(site=site)
frappe.connect()
def destroy_frappe():
frappe.destroy()