tornado/demos/README.rst

41 lines
1.4 KiB
ReStructuredText

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.