Loading...
Loading...
Scaffold and architect custom Frappe apps including app structure, hooks, background jobs, service layers, and production hardening. Use when creating new apps, setting up app architecture, or implementing cross-cutting patterns like caching, logging, and error handling.
npx skill4agent add lubusin/agent-skills frappe-app-developmenthooks.py# Create the app
bench new-app my_app
# Install on site
bench --site mysite.local install-app my_app
# Verify developer mode
bench --site mysite.local console
>>> frappe.conf.developer_mode # Must be Truemy_app/
├── my_app/
│ ├── __init__.py
│ ├── hooks.py # App hooks and configuration
│ ├── api.py # Public API surface (RPC endpoints)
│ ├── services/ # Business logic modules
│ │ └── billing.py
│ ├── utils/ # Cross-cutting utilities
│ │ ├── cache.py
│ │ ├── errors.py
│ │ ├── logging.py
│ │ ├── permissions.py
│ │ └── validation.py
│ ├── background_jobs/ # Async job handlers
│ │ └── export_job.py
│ ├── integrations/ # External system connectors
│ │ └── payment_gateway.py
│ ├── my_module/
│ │ ├── doctype/
│ │ │ └── my_doc/
│ │ │ ├── my_doc.json
│ │ │ ├── my_doc.py
│ │ │ ├── my_doc.js
│ │ │ └── test_my_doc.py
│ │ ├── report/
│ │ └── dashboard/
│ └── translations/
│ ├── en.csv
│ └── fr.csv
├── setup.py
└── README.mdassets/mini-app-template/# hooks.py
app_name = "my_app"
app_title = "My App"
app_publisher = "My Company"
# DocType lifecycle events
doc_events = {
"Sales Order": {
"on_submit": "my_app.services.billing.on_order_submit",
"on_cancel": "my_app.services.billing.on_order_cancel",
},
"*": {
"after_insert": "my_app.utils.logging.log_creation",
}
}
# Scheduled tasks
scheduler_events = {
"daily": [
"my_app.background_jobs.cleanup.run_daily_cleanup"
],
"cron": {
"0 */6 * * *": [
"my_app.background_jobs.sync.sync_external_data"
]
}
}
# Client-side script injection
doctype_js = {
"Sales Order": "public/js/sales_order.js"
}
doctype_list_js = {
"Sales Order": "public/js/sales_order_list.js"
}
# Override another app's controller (use sparingly)
# override_doctype_class = {
# "ToDo": "my_app.overrides.custom_todo.CustomToDo"
# }
# Extend controller without full replacement (v16+, preferred)
# extend_doctype_class = {
# "ToDo": "my_app.overrides.todo_extension.TodoExtension"
# }
# Override whitelisted methods
# override_whitelisted_methods = {
# "frappe.client.get_list": "my_app.overrides.custom_get_list"
# }# my_app/services/billing.py
import frappe
def on_order_submit(doc, method):
"""Handle order submission — called via doc_events hook."""
if doc.grand_total > 10000:
create_approval_request(doc)
generate_invoice(doc)
def generate_invoice(order):
"""Create invoice from submitted order."""
invoice = frappe.get_doc({
"doctype": "Sales Invoice",
"customer": order.customer,
"items": [
{"item_code": i.item_code, "qty": i.qty, "rate": i.rate}
for i in order.items
]
})
invoice.insert()
invoice.submit()
return invoice# my_app/background_jobs/export_job.py
import frappe
def enqueue_export(filters):
"""Enqueue a long-running export job."""
frappe.enqueue(
"my_app.background_jobs.export_job.run_export",
filters=filters,
queue="long",
timeout=600,
is_async=True
)
def run_export(filters):
"""Execute the export — runs in background worker."""
data = frappe.get_all("Sales Order", filters=filters, fields=["*"])
# Process data...
frappe.publish_realtime("export_complete", {"count": len(data)})# my_app/utils/cache.py
import frappe
def get_cached_settings(key):
"""Cache expensive settings lookups."""
value = frappe.cache().get_value(f"my_app:{key}")
if value is None:
value = frappe.db.get_single_value("My Settings", key)
frappe.cache().set_value(f"my_app:{key}", value)
return value
def invalidate_cache(key):
frappe.cache().delete_value(f"my_app:{key}")# my_app/utils/errors.py
import frappe
def api_error(message, status_code=400, exc=None):
"""Consistent error response for API endpoints."""
frappe.local.response["http_status_code"] = status_code
frappe.throw(message, exc or frappe.ValidationError)# In Python code
frappe._("Hello World") # Mark string for translation
# In JavaScript
__("Hello World") # Mark string for translation# Translation CSV files go in my_app/translations/
# e.g., my_app/translations/fr.csv:
# Hello World,Bonjour le monde| Feature | Minimum Version |
|---|---|
| Frappe v16+ |
REST API v2 ( | Frappe v15+ |
| Token-based auth | Frappe v11.0.3+ |
import frappe
if hasattr(frappe, 'extend_doctype_class'):
# v16+ pattern
pass
else:
# Fallback for older versions
passbench --site <site> install-app my_appbench --site <site> migratebench --site <site> run-tests --app my_appapps.txtsites/<site>/site_config.jsonhooks.pybench doctorfrappe-doctype-developmentfrappe-api-developmentfrappe-desk-customizationfrappe-frontend-developmentfrappe-printing-templatesfrappe-reportsfrappe-web-formsfrappe-testingfrappe-enterprise-patternsfrappe-managerfrappe-doctype-developmentfrappe-api-developmentfrappe-frontend-developmentfrappe-ui-patternsfrappe.versionfixtures| Mistake | Why It Fails | Fix |
|---|---|---|
App not in | App code not loaded | Run |
| Wrong module path in hooks | Events don't fire | Verify path matches actual |
| Duplicate hook registrations | Events fire multiple times | Check hooks.py for duplicates; use list not repeated keys |
| Editing hooks.py without restart | Changes not picked up | Run |
Missing | Module import errors | Ensure every directory has |
| Logic in hooks.py | Hard to test, import errors | Move logic to separate modules, import in hooks |
| Building frontend with vanilla JS/jQuery | Inconsistent with ecosystem | Use Frappe UI (Vue 3); see |
| Custom app shell for CRUD apps | Inconsistent UX | Follow CRM/Helpdesk patterns for navigation and layouts |