tornado/demos
Ben Darnell 3047d5c725 docs: Point to stable branch for all demo links
Add a README to the demos directory with a brief description of each,
and a warning about the usage of not-yet-released features.

Fixes #3236
2023-02-21 21:34:38 +00:00
..
blog web: Rename "secure_cookie" methods to "signed_cookie" 2023-01-23 18:51:53 +00:00
chat all: Support lazy imports of submodules 2022-11-27 15:41:27 -05:00
facebook web: Rename "secure_cookie" methods to "signed_cookie" 2023-01-23 18:51:53 +00:00
file_upload all: Support lazy imports of submodules 2022-11-27 15:41:27 -05:00
helloworld all: Support lazy imports of submodules 2022-11-27 15:41:27 -05:00
s3server deps: Update linters 2022-11-27 22:00:35 -05:00
tcpecho docs,demos: Update for asyncio.run pattern 2022-06-03 14:50:20 -04:00
twitter web: Rename "secure_cookie" methods to "signed_cookie" 2023-01-23 18:51:53 +00:00
websocket all: Support lazy imports of submodules 2022-11-27 15:41:27 -05:00
webspider Fix URL plural 2022-08-24 19:03:30 +04:30
README.rst docs: Point to stable branch for all demo links 2023-02-21 21:34:38 +00:00

README.rst

Tornado Demo Apps
-----------------

This directory contains several example apps that illustrate the usage of
various Tornado features. If you're not sure where to start, try the ``chat``,
``blog``, or ``websocket`` demos.

.. note::

    These applications require features due to be introduced in Tornado 6.3
    which is not yet released. Unless you are testing the new release,
    use the GitHub branch selector to access the ``stable`` branch
    (or the ``branchX.y`` branch corresponding to the version of Tornado you
    are using) to get a suitable version of the demos.

    TODO: remove this when 6.3 ships.

Web Applications
~~~~~~~~~~~~~~~~

- ``blog``: A simple database-backed blogging platform, including
  HTML templates and authentication.
- ``chat``: A chat room demonstrating live updates via long polling.
- ``websocket``: Similar to ``chat`` but with WebSockets instead of
  long polling.
- ``helloworld``: The simplest possible Tornado web page.
- ``s3server``: Implements a basic subset of the Amazon S3 API.

Feature demos
~~~~~~~~~~~~~

- ``facebook``: Authentication with the Facebook Graph API.
- ``twitter``: Authentication with the Twitter API.
- ``file_upload``: Client and server support for streaming HTTP request 
  payloads.
- ``tcpecho``: Using the lower-level ``IOStream`` interfaces for non-HTTP
  networking.
- ``webspider``: Concurrent usage of ``AsyncHTTPClient``, using queues and
  semaphores.