blob: 70a500d63f58fc467c187635115802188708743b (
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
|CherryPy Build Status| |Codacy Badge|
Welcome to the GitHub repository of `CherryPy <http://cherrypy.org/>`_!
CherryPy is a pythonic, object-oriented HTTP framework.
1. It allows building web applications in much the same way one would
build any other object-oriented program.
2. This design results in less and more readable code being developed faster.
It's all just properties and methods.
3. It is now more than ten years old and has proven fast and very
stable.
4. It is being used in production by many sites, from the simplest to
the most demanding.
5. And perhaps most importantly, it is fun to work with :-)
Here's how easy it is to write "Hello World" in CherryPy:
.. code:: python
import cherrypy
class HelloWorld(object):
@cherrypy.expose
def index(self):
return "Hello World!"
cherrypy.quickstart(HelloWorld())
And it continues to work that intuitively when systems grow, allowing
for the Python object model to be dynamically presented as a web site
and/or API.
While CherryPy is one of the easiest and most intuitive frameworks out
there, the prerequisite for understanding the `CherryPy
documentation <http://docs.cherrypy.org/en/latest/>`_ is that you have
a general understanding of Python and web development.
Additionally:
- Tutorials are included in the repository:
https://github.com/cherrypy/cherrypy/tree/master/cherrypy/tutorial
- A general wiki at(will be moved to github):
https://bitbucket.org/cherrypy/cherrypy/wiki/Home
- Plugins are described at: http://tools.cherrypy.org/
If the docs are insufficient to address your needs, the CherryPy
community has several `avenues for support
<https://docs.cherrypy.org/en/latest/support>`_.
Documentation
=============
- The official user documentation of CherryPy is at:
http://docs.cherrypy.org/en/latest/
Installation
============
To install CherryPy for use in your project, follow these instructions:
From the PyPI package
---------------------
.. code:: sh
pip install cherrypy
or (for python 3)
.. code:: sh
pip3 install cherrypy
From source
-----------
Change to the directory where setup.py is located and type (Python 2.6
or later needed):
.. code:: sh
python setup.py install
Development
===========
Contributing
------------
Please follow the `contribution
guidelines <https://github.com/cherrypy/cherrypy/blob/master/CONTRIBUTING.txt>`_.
And by all means, `absorb the Zen of
CherryPy <https://bitbucket.org/cherrypy/cherrypy/wiki/ZenOfCherryPy>`_.
Testing
-------
- To run the regression tests, first install tox:
.. code:: sh
pip install tox
then run it
.. code:: sh
tox
- To run individual tests type:
.. code:: sh
tox -- -k test_foo
.. |CherryPy Build Status| image:: https://travis-ci.org/cherrypy/cherrypy.svg?branch=master
:target: https://travis-ci.org/cherrypy/cherrypy
.. |Codacy Badge| image:: https://api.codacy.com/project/badge/Grade/48b11060b5d249dc86e52dac2be2c715
:target: https://www.codacy.com/app/webknjaz/cherrypy-upstream?utm_source=github.com&utm_medium=referral&utm_content=cherrypy/cherrypy&utm_campaign=Badge_Grade
|
