Duck Framework Documentation

Python Web Framework | No JavaScript Required

Duck Framework is an open-source Python web framework and web server that replaces JavaScript frontends entirely.

Build real-time, reactive web applications with pure Python — no React, no Vue, no JavaScript framework needed. A modern, full-stack alternative to Django and Flask with a built-in WebSocket-driven UI engine.

Duck is not a small or mini web framework — it is a full-fledged Python framework that lets you build and deploy complete web applications without writing a single line of JavaScript.

Github

• Homepage: https://github.com/duckframework/duck

Stay tuned for more updates as we continue to enhance Duck’s capabilities.

Author

• Author: Brian Musakwa

• Email: digreatbrian@gmail.com

Contents

Table of Contents:

• 🚀 Getting Started with Duck
  • 1. Install Duck
  • 2. Create Your First Project
  • 3. Run the Server
  • 4. Understand the Project Structure
  • web/main.py ➝‬ Entry Point (starts your app)
  • web/urls.py ➝‬ URL Routing (maps URLs to logic)
  • web/views.py ➝‬ Logic (what your app does)
  • How Everything Connects
  • Run Built-in Tests
  • Requirements
  • What Makes Duck Different?
  • Final Thought
• 🗨️ Build a Reactive Chat App in 5 Minutes
  • What you’ll get
  • Project structure
  • Step 1 — Message Bubble Component
  • Step 2 — Base Page (shared layout)
  • Step 3 — Chat Page (the main logic)
  • Step 4 — Wire up the route
  • Run it
  • How it works (under the hood)
  • Improvements (next level)
  • Common issues
  • Next: Deploy it
• 🌀 Project structure
  • Full project structure
  • Application Files
• 🗃 Cached Views
  • Overview
  • cached_view Decorator
  • Parameters
  • How Targets Work
  • Namespace Support
  • Debugging with Skip
  • on_cache_result Hook
  • Internal Behavior
  • Examples
  • Best Practices
  • Comparison to Other Frameworks
  • Summary
• 🛠 Settings Configuration
  • Understanding settings.py
• 🖥️ Lively Component System
  • What Is the Lively Component System?
  • What Problem Does It Solve?
  • How It Works (Simple Explanation)
  • Why It’s Powerful
  • Beginner Mental Model
  • Page Component Example
  • Component Events
  • Fast Navigation
  • Pre-rendering Components
  • Counter App
  • Notes
  • Components in Templates
  • Custom Components
  • Component Extensions
  • Predefined Components
  • Force Updates on Lively Components
  • Handling Forms
  • Component Lifecycle
  • Other points to Note
• 📟 Simple Counter App in Python
  • views.py
  • How to use
  • Notes
• 🌀 Component Caching Utilities
  • Key Concepts
  • Default Cache Backend
  • Exceptions
  • Cache Key Generation
  • cached_component Decorator
  • Runtime Behavior
  • Background Optimization
  • Functional API
  • Static Component Utilities
  • static_component Decorator
  • Functional API
  • When to Use What
  • Summary
• 📑 Templates
  • Rendering Functions
  • Template Syntax
  • Template Locations
  • Rendering Templates in Views
  • Blueprint Templates
  • Summary
• 🏷️ Template Tags & Filters
  • Syntax Overview
  • Quick Cheatsheet
  • Example Usage
  • Notes
• 📘 Blueprints
  • Blueprint Structure Example
  • Example
  • Blueprint arguments
• ⛴️ Micro Applications
  • What is a Micro App?
  • Key Features
  • How to Use Micro Apps
• ⏳ Task Automation
  • Usage and Explanation
  • Automation Trigger
  • Automation Dispatcher
• 🚧 HTTP/2 and HTTPS
  • Leveraging HTTP/2
  • Enabling HTTPS
  • Local SSL Certificate Generation
  • Production Recommendations
• 🖥️ Web Server Gateway (WSGI)
  • Enabling WSGI Mode
  • Working with the Event Loop
  • Notes
  • Defining Sync Views
• ⚡ Asynchronous Server Gateway (ASGI)
  • Enabling Async Handling
  • Notes
  • Defining Async Views
• 🌐 WebSockets in Python – Real-Time Apps with Duck
  • Quick Example
  • Customizing Behavior
  • Practical Examples
• 🔋Background Thread & Asyncio Loop Managers
  • Threadpool Manager
  • Asyncio Loop Manager
  • Summary of Best Practices
• 🔀 Request & Response
  • Requests
  • Responses
• 🔐 Sessions in Duck
  • Session Storage Options
  • Accessing Sessions
  • Session Settings
  • Notes & Tips
• 🛡️ Duck Middlewares
  • Base Middleware Class
• 📝 Duck Logging System
  • Other Logging Options
  • Logs CLI
• 🗄️️ Database
  • Setup
  • Example
  • Running Database Migrations
  • Asynchronous Support
  • Admin Page
• 🐤 Django Integration with Duck
  • What is Django ?
  • How It Works
  • Why Use Duck with Django
  • Integration Steps
  • Notes
  • Deep Dive
• 📄 Sitemap
  • Configuration
  • Best Practices
  • Using SitemapBuilder
• 🚀 Deployment Guide
  • Prerequisites
  • Steps to Deploy Your Duck Application
  • Notes & Best Practices
  • You’re Done!
• 📊 Duck System Monitor
  • Key Features
  • Usage
  • Notes
• 🌐 Duck Service Management
  • Requirements
  • Commands Overview
• 🔐 Free SSL Certificate
  • Obtaining SSL Certificate
  • Domain Verification Setup
  • Generating SSL Certificate
  • Final Configuration Overview
  • Debugging
  • Tips & Notes
• 🔌 Socket I/O (xsocket)
  • Getting Started
  • Synchronous Example
  • Asynchronous Example
  • Notes
  • Performance Tips
• 💡Duck Shortcuts
  • Features
  • Available Functions
• ⌛ Duck Utilities
  • Features
  • Submodules

API Documentation:

• API Reference
  • duck