README.rst 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. Flask
  2. =====
  3. Flask is a lightweight `WSGI`_ web application framework. It is designed
  4. to make getting started quick and easy, with the ability to scale up to
  5. complex applications. It began as a simple wrapper around `Werkzeug`_
  6. and `Jinja`_ and has become one of the most popular Python web
  7. application frameworks.
  8. Flask offers suggestions, but doesn't enforce any dependencies or
  9. project layout. It is up to the developer to choose the tools and
  10. libraries they want to use. There are many extensions provided by the
  11. community that make adding new functionality easy.
  12. .. _WSGI: https://wsgi.readthedocs.io/
  13. .. _Werkzeug: https://werkzeug.palletsprojects.com/
  14. .. _Jinja: https://jinja.palletsprojects.com/
  15. Installing
  16. ----------
  17. Install and update using `pip`_:
  18. .. code-block:: text
  19. $ pip install -U Flask
  20. .. _pip: https://pip.pypa.io/en/stable/getting-started/
  21. A Simple Example
  22. ----------------
  23. .. code-block:: python
  24. # save this as app.py
  25. from flask import Flask
  26. app = Flask(__name__)
  27. @app.route("/")
  28. def hello():
  29. return "Hello, World!"
  30. .. code-block:: text
  31. $ flask run
  32. * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
  33. Contributing
  34. ------------
  35. For guidance on setting up a development environment and how to make a
  36. contribution to Flask, see the `contributing guidelines`_.
  37. .. _contributing guidelines: https://github.com/pallets/flask/blob/main/CONTRIBUTING.rst
  38. Donate
  39. ------
  40. The Pallets organization develops and supports Flask and the libraries
  41. it uses. In order to grow the community of contributors and users, and
  42. allow the maintainers to devote more time to the projects, `please
  43. donate today`_.
  44. .. _please donate today: https://palletsprojects.com/donate
  45. Links
  46. -----
  47. - Documentation: https://flask.palletsprojects.com/
  48. - Changes: https://flask.palletsprojects.com/changes/
  49. - PyPI Releases: https://pypi.org/project/Flask/
  50. - Source Code: https://github.com/pallets/flask/
  51. - Issue Tracker: https://github.com/pallets/flask/issues/
  52. - Website: https://palletsprojects.com/p/flask/
  53. - Twitter: https://twitter.com/PalletsTeam
  54. - Chat: https://discord.gg/pallets