0.1.2

v0.1.2

📝 Add Docs for Usage Examples

0.1.1

• Add OpenAPI setup documentation

Documentation: https://0xsirsaif.github.io/frappe-api/
PyPI Package: https://pypi.org/project/frappeapi/

0.1.0

FrappeAPI v0.1.0 Release Notes

First beta release of FrappeAPI, providing enhanced API capabilities for Frappe applications.

see PyPI Package

Installation

pip install frappeapi

Features

HTTP Methods

• Complete implementation of REST methods: GET, POST, PUT, PATCH, DELETE

Query Parameters

• Type hint-based automatic parsing and conversion
• Support for required and optional parameters
• Enum, Boolean, and List parameters
• Parameter aliases
• Query parameter as Pydantic model

Body Parameters

• Body as Pydantic model
• Multiple body parameters
• Singular value support with Body()
• Nested model support

Header Parameters

• Basic header parameter support

Form Data

• Form field support using Form()
• Multiple form fields
• Form Data as Pydantic model

File Uploads

• Basic file upload support with File()
• UploadFile support for large files

Error Handling

• HTTPException support
• Request/Response validation
• Custom exception handlers
• Default handler override capability

Response Models

• Response as Pydantic model
• Return annotations as response model
• Limit and filter data based on the Response model

Validation & Metadata

• String validations (min_length, max_length, pattern)
• Numeric validations (gt, ge, lt, le)
• Metadata support (title, description, deprecated)

Compatibility

• Supports Frappe V14

Known Limitations

• Dependencies
• Middlewares
• Rate Limit