Werkzeug

werkzeug German noun: “tool”. Etymology: werk (“work”), zeug (“stuff”)

Werkzeug is a comprehensive WSGI web application library. It began as a simple collection of various utilities for WSGI applications and has become one of the most advanced WSGI utility libraries.

Werkzeug doesn’t enforce any dependencies. It is up to the developer to choose a template engine, database adapter, and even how to handle requests.

Getting Started

• Installation
  • Python Version
  • Virtual environments
  • Install Werkzeug
• Werkzeug Tutorial
  • Introducing Shortly
  • Step 0: A Basic WSGI Introduction
  • Step 1: Creating the Folders
  • Step 2: The Base Structure
  • Intermezzo: Running the Application
  • Step 3: The Environment
  • Step 4: The Routing
  • Step 5: The First View
  • Step 6: Redirect View
  • Step 7: Detail View
  • Step 8: Templates
  • Step 9: The Style
  • Bonus: Refinements
• API Levels
  • Example
  • High or Low?
• Quickstart
  • WSGI Environment
  • Enter Request
  • Header Parsing
  • Responses

Serving and Testing

• Serving WSGI Applications
  • run_simple()
  • is_running_from_reloader()
  • make_ssl_devcert()
  • Reloader
  • Colored Logging
  • Virtual Hosts
  • Shutting Down The Server
  • Troubleshooting
  • SSL
  • Unix Sockets
• Testing WSGI Applications
  • Test Client
  • Request Body
  • Environment Builder
  • API
• Debugging Applications
  • Enabling the Debugger
  • Using the Debugger
  • Debugger PIN
  • Allowed Hosts
  • Pasting Errors

Reference

• Request / Response Objects
  • How they Work
  • Mutability and Reusability of Wrappers
  • Wrapper Classes
• URL Routing
  • Quickstart
  • Rule Format
  • Built-in Converters
  • Maps, Rules and Adapters
  • Matchers
  • Rule Factories
  • Rule Templates
  • Custom Converters
  • Host Matching
  • WebSockets
  • State Machine Matching
• WSGI Helpers
  • Iterator / Stream Helpers
  • Environ Helpers
  • Convenience Helpers
  • Bytes, Strings, and Encodings
  • Raw Request URI and Path Encoding
• HTTP Utilities
  • Datetime Functions
  • Header Parsing
  • Header Utilities
  • Cookies
  • Conditional Response Helpers
  • Constants
  • Form Data Parsing
• Data Structures
  • General Purpose
  • HTTP Related
  • Others
• Utilities
  • General Helpers
  • URL Helpers
  • User Agent API
  • Security Helpers
  • Logging
• URL Helpers
  • uri_to_iri()
  • iri_to_uri()
• Context Locals
• Proxy Objects
  • LocalProxy
• Stacks and Namespaces
  • LocalStack
  • Local
• Releasing Data
  • LocalManager
  • release_local()
• Middleware
  • X-Forwarded-For Proxy Fix
  • Serve Shared Static Files
  • Application Dispatcher
  • Basic HTTP Proxy
  • WSGI Protocol Linter
  • Application Profiler
• HTTP Exceptions
  • Usage Example
  • Error Classes
  • Baseclass
  • Special HTTP Exceptions
  • Simple Aborting
  • Custom Errors

Deployment

• Deploying to Production
  • Self-Hosted Options
    • Gunicorn
    • Waitress
    • mod_wsgi
    • uWSGI
    • gevent
    • eventlet
    • Tell Werkzeug it is Behind a Proxy
    • nginx
    • Apache httpd
  • Hosting Platforms

Additional Information

• Important Terms
  • WSGI
  • Response Object
  • View Function
• Dealing with Request Data
  • Missing EOF Marker on Input Stream
  • When does Werkzeug Parse?
  • How does it Parse?
  • Limiting Request Data
  • How to extend Parsing?
• BSD-3-Clause License
• Changes
  • Version 3.1.0
  • Version 3.0.4
  • Version 3.0.3
  • Version 3.0.2
  • Version 3.0.1
  • Version 3.0.0
  • Version 2.3.8
  • Version 2.3.7
  • Version 2.3.6
  • Version 2.3.5
  • Version 2.3.4
  • Version 2.3.3
  • Version 2.3.2
  • Version 2.3.1
  • Version 2.3.0
  • Version 2.2.3
  • Version 2.2.2
  • Version 2.2.1
  • Version 2.2.0
  • Version 2.1.2
  • Version 2.1.1
  • Version 2.1.0
  • Version 2.0.3
  • Version 2.0.2
  • Version 2.0.1
  • Version 2.0.0
  • Version 1.0.1
  • Version 1.0.0
  • Version 0.16.1
  • Version 0.16.0
  • Version 0.15.6
  • Version 0.15.5
  • Version 0.15.4
  • Version 0.15.3
  • Version 0.15.2
  • Version 0.15.1
  • Version 0.15.0
  • Version 0.14.1
  • Version 0.14
  • Version 0.13
  • Version 0.12.2
  • Version 0.12.1
  • Version 0.12
  • Version 0.11.16
  • Version 0.11.15
  • Version 0.11.14
  • Version 0.11.13
  • Version 0.11.12
  • Version 0.11.11
  • Version 0.11.10
  • Version 0.11.9
  • Version 0.11.8
  • Version 0.11.7
  • Version 0.11.6
  • Version 0.11.5
  • Version 0.11.4
  • Version 0.11.3
  • Version 0.11.2
  • Version 0.11.1
  • Version 0.11
  • Version 0.10.5
  • Version 0.10.4
  • Version 0.10.3
  • Version 0.10.2
  • Version 0.10.1
  • Version 0.10
  • Version 0.9.7
  • Version 0.9.6
  • Version 0.9.7
  • Version 0.9.5
  • Version 0.9.4
  • Version 0.9.3
  • Version 0.9.2
  • Version 0.9.1
  • Version 0.9
  • Version 0.8.4
  • Version 0.8.3
  • Version 0.8.2
  • Version 0.8.1
  • Version 0.8
  • Version 0.7.2
  • Version 0.7.1
  • Version 0.7
  • Version 0.6.2
  • Version 0.6.1
  • Version 0.6
  • Version 0.5.1
  • Version 0.5
  • Version 0.4.1
  • Version 0.4
  • Version 0.3.1
  • Version 0.3
  • Version 0.2
  • Version 0.1