Microdot

“The impossibly small web framework for Python and MicroPython”

Microdot is a minimalistic Python web framework inspired by Flask. Given its size, it can run on systems with limited resources such as microcontrollers. Both standard Python (CPython) and MicroPython are supported.

• Installation
  • CPython Installation
  • MicroPython Installation
• Getting Started
  • A Simple Microdot Web Server
    • Running with CPython
    • Running with MicroPython
    • Web Server Configuration
  • Defining Routes
    • Choosing the HTTP Method
    • Including Dynamic Components in the URL Path
    • Before and After Request Handlers
    • Error Handlers
    • Mounting a Sub-Application
    • Shutting Down the Server
  • The Request Object
    • Request Attributes
    • JSON Payloads
    • URLEncoded Form Data
    • Accessing the Raw Request Body
    • Cookies
    • The “g” Object
    • Request-Specific After-Request Handlers
    • Request Limits
  • Responses
    • The Three Parts of a Response
    • JSON Responses
    • Redirects
    • File Responses
    • Streaming Responses
    • Changing the Default Response Content Type
    • Setting Cookies
  • Concurrency
• Core Extensions
  • WebSocket Support
  • Server-Sent Events Support
  • Rendering Templates
    • Using the uTemplate Engine
    • Using the Jinja Engine
  • Maintaining Secure User Sessions
  • Cross-Origin Resource Sharing (CORS)
  • Testing with the Test Client
  • Deploying on a Production Web Server
    • Using an ASGI Web Server
    • Using a WSGI Web Server
• Migrating to Microdot 2.x from Older Releases
  • Code reorganization
  • No more synchronous web server
  • Removed extensions
  • No more render_template() function
  • Class-based user sessions
  • WSGI extension redesign
• Cross-Compiling and Freezing Microdot (MicroPython Only)
  • Choosing What Modules to Install
  • Cross-Compiling
  • Freezing
• API Reference
  • Core API
    • Microdot
    • Request
    • Response
  • WebSocket
    • WebSocketError
    • WebSocket
    • websocket_upgrade()
    • with_websocket()
  • Server-Sent Events (SSE)
    • SSE
    • sse_response()
    • with_sse()
  • Templates (uTemplate)
    • Template
  • Templates (Jinja)
    • Template
  • User Sessions
    • SessionDict
    • Session
    • with_session()
  • Cross-Origin Resource Sharing (CORS)
    • CORS
  • Test Client
    • TestClient
    • TestResponse
  • ASGI
    • Microdot
  • WSGI
    • Microdot

• Index

• Search Page