flask README

The project's README from github.com/pallets/flask. As one markdown file: README.md.

Flask

Flask is a lightweight WSGI web application framework. It is designed to make getting started quick and easy, with the ability to scale up to complex applications. It began as a simple wrapper around Werkzeug and Jinja, and has become one of the most popular Python web application frameworks.

Flask offers suggestions, but doesn't enforce any dependencies or project layout. It is up to the developer to choose the tools and libraries they want to use. There are many extensions provided by the community that make adding new functionality easy.

A Simple Example

# save this as app.py
from flask import Flask

app = Flask(__name__)

@app.route("/")
def hello():
    return "Hello, World!"
$ flask run
  * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

Donate

The Pallets organization develops and supports Flask and the libraries it uses. In order to grow the community of contributors and users, and allow the maintainers to devote more time to the projects, please donate today.

Contributing

See our detailed contributing documentation for many ways to contribute, including reporting issues, requesting features, asking or answering questions, and making PRs.

flask (pallets/flask)

Searching Database…

74.9K ·GitHub
What is this?Flask is a lightweight WSGI web application framework for Python — designed to make getting started quick and easy, with the ability to scale up to complex applications.
So is it an app I install and run, or something I build with?Something you build with: it is a Python framework you import and write your own web application on top of, not a finished product you deploy as-is.
How do I add it to a Python project?Install the package into your environment with pip install Flask, then follow the quickstart in the official Flask docs to build your first app.
Will it lock me into particular tools or a project structure?No — Flask offers suggestions but doesn't enforce any dependencies or project layout; choosing the tools and libraries is up to the developer.
Does it care whether I'm on Windows, macOS, or Linux?No — it is pure Python without OS-specific requirements, so it runs wherever Python does, including Windows, macOS and Linux.
What if I need things like logins, databases, or form handling?That is what extensions are for: the community provides many extensions that make adding new functionality easy, so the core can stay minimal.
What is Flask built on under the hood?It began as a simple wrapper around Werkzeug and Jinja, and the pair still anchors the stack: Werkzeug covers the WSGI layer, Jinja does HTML templating.
Is it mature enough to bet a real project on?It has been developed since 2010, has become one of the most popular Python web application frameworks, and the Pallets organization develops and supports it.
What are similar projects?Slim, express, hapi, jinja, revel, echo, beego, Rocket
Creator
pallets
Size
11.9 MB
Stars
74.9K
Age
16y
Commits · 90 Days