summaryrefslogtreecommitdiff
path: root/docs/index.rst
blob: 15834b7e35f2bf7a06ba9aafb82a37f74ab5d5a6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

CherryPy — A Minimalist Python Web Framework
============================================

.. toctree::
   :hidden:

   intro.rst
   install.rst
   tutorials.rst
   basics.rst
   advanced.rst
   config.rst
   extend.rst
   deploy.rst
   support.rst
   enterprise.rst
   contribute.rst
   development.rst
   glossary.rst
   history.rst

.. toctree::
   :hidden:
   :caption: Reference

   pkg/modules

`CherryPy <http://www.cherrypy.dev>`_ is a pythonic, object-oriented web framework.

CherryPy allows developers to build web applications in much the
same way they would build any other object-oriented Python program.
This results in smaller source code developed in less time.

CherryPy is now more than ten years old, and it has proven to
be fast and reliable. It is being used in production by many
sites, from the simplest to the most demanding.

A CherryPy application typically looks like this:

.. code-block:: python

   import cherrypy

   class HelloWorld(object):
       @cherrypy.expose
       def index(self):
           return "Hello World!"

   cherrypy.quickstart(HelloWorld())

In order to make the most of CherryPy, you should start
with the :ref:`tutorials <tutorials>` that will lead you through the most common
aspects of the framework. Once done, you will probably want to
browse through the :ref:`basics <basics>` and :ref:`advanced <advanced>`
sections that will demonstrate how to implement certain operations.
Finally, you will want to carefully read the configuration and
:ref:`extend <extend>` sections that go in-depth regarding the
powerful features provided by the framework.

Above all, have fun with your application!