How do I implement permission checks in APIs?

The skill includes patterns for using frappe.has_permission within whitelisted functions to ensure users have the necessary rights before an operation executes.

How are background tasks handled?

The skill provides templates for enqueuing immediate jobs via frappe.enqueue and defining scheduled events in the hooks.py file.

What parts of the Frappe lifecycle does this skill cover?

It covers the entire Document lifecycle, including naming, validation, before/after save hooks, submission, and cancellation events.

Can I use this for creating public APIs in Frappe?

Yes, it includes specific patterns for whitelisted APIs, including those that allow guest access and those restricted by HTTP methods.

Does this skill support raw SQL queries?

Yes, it provides syntax and examples for both Frappe's high-level ORM (get_all, get_doc) and raw SQL execution with safe parameter binding.

Frappe Server-Side Logic

Name: Frappe Server-Side Logic
Author: UnityAppSuite

byUnityAppSuite

API Development

Provides comprehensive patterns for Python-based server-side development in the Frappe Framework, including controllers, APIs, and database operations.

About

This skill equips Claude with the specific expertise needed to build robust backends for Frappe and ERPNext applications. It provides detailed templates for Document controllers, lifecycle hooks (like validate, on_submit, and on_cancel), and secure whitelisted APIs. Whether you are managing complex database transactions via Frappe's ORM, scheduling background tasks with Redis Queue, or implementing fine-grained permission checks, this reference ensures your code follows Frappe's best practices for maintainability and performance.

Key Features

Efficient database operations using Frappe ORM and raw SQL queries
Background job management and task scheduling via hooks.py configuration
0 GitHub stars
Complete Document controller lifecycle templates for validation and submission
Standardized patterns for whitelisted REST API endpoints and guest access
Best practices for Frappe error handling and permission validation

Use Cases

Automating data processing and long-running tasks using Frappe's background job system
Building secure, permission-aware API endpoints for external integrations or custom frontends
Implementing complex business logic and field validation in Frappe Document controllers

About

Key Features

Efficient database operations using Frappe ORM and raw SQL queries
Background job management and task scheduling via hooks.py configuration
0 GitHub stars
Complete Document controller lifecycle templates for validation and submission
Standardized patterns for whitelisted REST API endpoints and guest access
Best practices for Frappe error handling and permission validation

Use Cases

Automating data processing and long-running tasks using Frappe's background job system
Building secure, permission-aware API endpoints for external integrations or custom frontends
Implementing complex business logic and field validation in Frappe Document controllers