# Bottle: Python Web Framework

Bottle is a fast, simple and lightweight WSGI micro web-framework for Python. It is distributed as a single file module and has no dependencies other than the Python Standard Library.

- Routing: Requests to function-call mapping with support for clean and dynamic URLs.

- Templates: Fast and pythonic built-in template engine and support for mako, jinja2 and cheetah templates.

- Utilities: Convenient access to form data, file uploads, cookies, headers and other HTTP-related metadata.

- Server: Built-in HTTP development server and support for a wide range of WSGI capable HTTP server (e.g. gunicorn, paste or cheroot).

Example: “Hello World” in a bottle

    from bottle import route, run, template

    @route('/hello/<name>')
    def index(name):
        return template('<b>Hello {{name}}</b>!', name=name)

    run(host='localhost', port=8080)

Run this script or paste it into a Python console, then point your browser to http://localhost:8080/hello/world. That’s it.

## Download and Install

Install the latest stable release with `pip install bottle` or download bottle.py (unstable) into your project directory. There are no hard [1] dependencies other than the Python standard library.

## Dead Snakes

Bottle up to version 0.12 supported an absurd number of python versions, some of which reached their end-of-life well over a decade ago. Starting with Bottle 0.13 we will keep compatibility with maintained versions of Python only and drop support for “dead snakes” with each new bottle release. If you are in the unfortunate position to have to rely on a truly ancient version of Python, just stick with a compatible bottle release. Everyone else should update regularly to benefit from new features and improvements.

Python Support Matrix
Bottle Version | Python 2 | Python 3
--- | --- | ---
0.12 | 2.5, 2.6, 2.7 | 3.2 - 3.12
0.13 | 2.7 | 3.8 - 3.x
1.0 (planned) | dropped | 3.8 - 3.x

## Documentation

Getting Started

- User’s Guide
  - Installation
  - Hello World!
  - The Application Object
  - Debug Mode
  - Command Line Interface
  - Request Routing
  - Serving Assets
  - Generating content
  - Error handling
  - Request Data
  - Templates
  - Structuring Applications
  - Glossary
- API Reference
  - Global functions
  - Global decorators
  - Request Context
  - Helper Functions
  - Exceptions
  - The `Bottle` Class
  - The `Request` Object
  - The `Response` Object
  - Data Structures
  - Request routing
  - Templating
  - HTTP utilities
  - Misc utilities
- Release Notes
  - Release 0.13
  - Release 0.12
  - Release 0.11
  - Release 0.10
  - Release 0.9
  - Release 0.8
- F.A.Q.
  - General questions
  - Common errors and pitfalls
  - Recieps for common tasks

Advanced Topics

- Request Routing
  - Rule Syntax
  - Wildcard Filters
  - Legacy Syntax
  - Explicit routing configuration
- Configuration
  - Configuration Basics
  - Naming Convention
  - Load configuration from a File
  - Load configuration from a python module
  - Loading configuration from a `dict`
  - Listening to configuration changes
  - Filters and other Meta Data
  - API Documentation
- SimpleTemplate
  - `SimpleTemplate` Syntax
  - Template Functions
  - `SimpleTemplate` API
- Deployment
  - Scaling for Production
- Asynchronous Applications
  - The Limits of Synchronous WSGI
  - Greenlets to the rescue
  - Event Callbacks
  - Finally: WebSockets

Plugins

- Using Plugins
  - Plugin Basics
  - Managing Plugins
  - Configuring Plugins
- Writing Plugins
  - Plugin API
  - The Route Context
  - Runtime optimizations
  - Common patterns
  - Plugin Example: SQLitePlugin
- 3rd Party Plugins

Additional Notes

- Todo-List Example
  - Goals
  - Before We Start…
  - Using Bottle for a Web-Based ToDo List
  - Server Setup
  - Final Words
  - Complete Example Listing

Development

- Developer Notes
  - Get involved
  - Get the Sources
  - Releases and Updates
  - Repository Structure
  - Submitting Patches
  - Building the Documentation
  - GIT Workflow Examples
- Contributors

## License

Code and documentation are available according to the MIT License:

    Copyright (c) 2009-2024, Marcel Hellkamp.

    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    THE SOFTWARE.

The Bottle logo however is NOT covered by that license. It is allowed to use the logo as a link to the bottle homepage or in direct context with the unmodified library. In all other cases please ask first.

Footnotes

[1]

Usage of the template or server adapter classes requires the corresponding template or server modules.