diff options
Diffstat (limited to 'vendor/CherryPy-3.2.0/sphinx/source/intro')
4 files changed, 0 insertions, 355 deletions
diff --git a/vendor/CherryPy-3.2.0/sphinx/source/intro/index.rst b/vendor/CherryPy-3.2.0/sphinx/source/intro/index.rst deleted file mode 100644 index 678ee69..0000000 --- a/vendor/CherryPy-3.2.0/sphinx/source/intro/index.rst +++ /dev/null @@ -1,77 +0,0 @@ -************ -Introduction -************ - -What is CherryPy? -================= - -CherryPy is a pythonic, object-oriented HTTP 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 does its best to stay out of the way between the programmer and the -problem. It works out of the box; default behavior is sensible enough to allow -use without extensive setup or customization. However, its configuration -and plugin systems are more than enough to easily build and deploy complex -sites. - -You are free to use any kind of templating, data access etc. technology -you want. CherryPy also has built-in tools for sessions, static files, cookies, -file uploads, caching, encoding, authorization, compression, and many more. - -The production-ready, HTTP/1.1-compliant web server allows you to deploy -web applications anywhere Python is installed. It also supports any other -WSGI-enabled webserver or adapter, including Apache, IIS, lighttpd, mod_python, -FastCGI, SCGI, and mod_wsgi, even multiple ones. And it's *fast*; typically, -CherryPy itself takes only 1-2ms per request! It is being used in production -by many sites, from the simplest to the most demanding. - -CherryPy applications run on Windows, Linux, Mac OS X and any other platform -supporting Python 2.3 or higher. - -CherryPy is now more than eight years old and it is has proven very fast and -stable. It is well tested, and includes tools for testing, profiling, and -coverage of your own applications. - -Oh, and most importantly: CherryPy is fun to work with :-) -Here's how easy it is to write "Hello World" in CherryPy:: - - import cherrypy - - class HelloWorld(object): - def index(self): - return "Hello World!" - index.exposed = True - - cherrypy.quickstart(HelloWorld()) - - -What CherryPy is NOT? -===================== - -As an HTTP framework, CherryPy does all that is necessary to allow Python code -to be executed when some resource (URL) is requested by the user. However: - - * CherryPy is not a templating language, such as PHP. CherryPy can work with - several Python templating packages (see :doc:`/progguide/choosingtemplate`), - but does not ship one by default. - * CherryPy does not fill out HTML forms for you. You're free to use formencode - or any other solution, or none at all if you're not using HTML ;) - * CherryPy is not a database or ORM. Rather than dictate or bless a persistence - layer to you, CherryPy allows you to choose your own. - - -Contents -======== - -.. toctree:: - :maxdepth: 3 - :glob: - - whycherrypy - install - license - - diff --git a/vendor/CherryPy-3.2.0/sphinx/source/intro/install.rst b/vendor/CherryPy-3.2.0/sphinx/source/intro/install.rst deleted file mode 100644 index 39dfbca..0000000 --- a/vendor/CherryPy-3.2.0/sphinx/source/intro/install.rst +++ /dev/null @@ -1,144 +0,0 @@ -************ -Installation -************ - -:ref:`prerequisites` - -:ref:`stableversions` - -:ref:`developmentversions` - -.. _prerequisites: - -Prerequisites -============= - -All you need is a working version of Python-2.3 or later on your computer. - -Get Python on Debian:: - - $ apt-get install python python-dev - - -.. _stableversions: - -Stable versions -=============== - -Download --------- - -You may download this version from http://download.cherrypy.org/cherrypy/3.2.0rc1/ - -For other releases, browse our -`download index <http://download.cherrypy.org/ download index>`_. - -Windows Installation --------------------- - -* Download the latest CherryPy release from the - `repository <http://download.cherrypy.org/cherrypy/>`_. - Select the file ending in ".exe" -* Run the downloaded file. - -Unix/Mac Installation ---------------------- - -* Download the latest CherryPy release from the - `repository <http://download.cherrypy.org/cherrypy/>`_. -* Unzip/untar the files -* Go to the directory created by the file extraction. -* Type "python setup.py install" to install the CherryPy module - -Next Steps ----------- - -* To run your first sample website, go to cherrypy/tutorial/ and type - "python tut01_helloworld.py", and you'll have a running website on port 8080. -* Open your favorite browser and point it to http://localhost:8080 to see your - first CherryPy-served page :-) - -Now, you should try running some of the other tutorials found in the tutorial -directory and look at their source code to understand how to develop a website -with CherryPy. - -.. _developmentversions: - -Development versions -==================== - -CherryPy's source code is managed using `Subversion <http://subversion.tigris.org>`_, -a source code control system. - -You can access our Subversion repository using your favorite Subversion client -at http://svn.cherrypy.org - -For Windows users, we recommend the wonderful Subversion client -`TortoiseSVN <http://tortoisesvn.tigris.org/>`_. Users of other operating -systems are advised to use multi-platform, Qt-based -`eSVN <http://esvn.umputun.com/>`_ or the command line tools provided by the -`core Subversion distribution <http://subversion.tigris.org/>`_. - -Note: In some cases http access fails with the error 'Cannot checkout' even -though the web interface works fine. This is usually because of a proxy between -you and the server which doesn't support all the access methods that SVN needs. -Many ISPs insert a transparent proxy on all http traffic, causing this problem. -The solution is to switch to https access so the proxy cannot interfere. - -You may also browse present and past versions of CherryPy source code, -inspect change sets, and even follow changes to specific trees/files using -RSS feeds. This web interface is located at http://www.cherrypy.org/browser/ - -Usage notes ------------ - -* The repository is open for anonymous read-only access. CherryPy developers - have write permissions. To obtain write permission, please contact us via - email or IRC (see http://www.cherrypy.org/wiki/CherryPyInvolved). -* The repository follows the standard trunk/branches/tags structure that is - recommended in the Subversion documentation: - - * ``trunk`` contains the official development code. Please do not checkin - any code on trunk that is untested, or that breaks the test suite. - * ``branches`` contain experimental branches. Patches for complex tickets - may also be developed and tested on a branch, to allow for easier - collaboration during test of inherently unstable features. - * ``tags`` contain frozen, known quality releases. - -Configuring the Subversion client ---------------------------------- - -Popular Subversion clients, including TortoiseSVN and the standard command line -tools, are configurable by editing a standard ``config`` file. The file is -stored at: - - * **Linux**: ``~/.subversion/config`` - * **Windows XP, 2000, NT**: ``%APPDATA%\Subversion\config`` - * **Windows 98 (and possibly ME also)**: ``\Windows\Application Data\Subversion\config`` - -Configuration is necessary because line endings do matter for Subversion, and -different code editors and IDEs use different conventions. This problem can be -solved by telling Subversion to automatically map the line endings of the code -in the repository to the conventions of your local install. The configuration -file should contain the following entries:: - - [miscellany] - global-ignores = *.o *.lo *.la #*# .*.rej *.rej .*~ *~ .#* .DS_Store *.pyc - enable-auto-props = yes - - [auto-props] - *.py = svn:eol-style=native - README.* = svn:eol-style=CRLF - *.TXT = svn:eol-style=CRLF - -The miscellany section contains two important settings: first, it tells -Subversion to ignore pyc files (in addition to the standard files it already -ignores); and also, it enables the auto-props section, which in turn provides -the standard line-ending convention. - -Standalone WSGI server ----------------------- - -The WSGI server that comes bundled with CherryPy is available as a standalone -module. Feel free to use it for all of your WSGI serving needs. - diff --git a/vendor/CherryPy-3.2.0/sphinx/source/intro/license.rst b/vendor/CherryPy-3.2.0/sphinx/source/intro/license.rst deleted file mode 100644 index e4805eb..0000000 --- a/vendor/CherryPy-3.2.0/sphinx/source/intro/license.rst +++ /dev/null @@ -1,32 +0,0 @@ -********************** -CherryPy License (BSD) -********************** - -:: - - Copyright (c) 2002-2010, CherryPy Team (team@cherrypy.org) - All rights reserved. - - Redistribution and use in source and binary forms, with or without modification, - are permitted provided that the following conditions are met: - - * Redistributions of source code must retain the above copyright notice, - this list of conditions and the following disclaimer. - * Redistributions in binary form must reproduce the above copyright notice, - this list of conditions and the following disclaimer in the documentation - and/or other materials provided with the distribution. - * Neither the name of the CherryPy Team nor the names of its contributors - may be used to endorse or promote products derived from this software - without specific prior written permission. - - THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND - ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED - WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE - DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE - FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL - DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR - SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER - CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, - OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - diff --git a/vendor/CherryPy-3.2.0/sphinx/source/intro/whycherrypy.rst b/vendor/CherryPy-3.2.0/sphinx/source/intro/whycherrypy.rst deleted file mode 100644 index eaa0146..0000000 --- a/vendor/CherryPy-3.2.0/sphinx/source/intro/whycherrypy.rst +++ /dev/null @@ -1,102 +0,0 @@ -******************** -Why choose CherryPy? -******************** - -Let's face it: there are **dozens** of different Python web frameworks. Why would -you want to choose CherryPy for your next dynamic Web project? - -1. Simplicity -------------- - -Developing with CherryPy is a simple task. "Hello, world" is only a few lines -long, and does not require the developer to learn the entire (albeit very -manageable) framework all at once. The framework is very pythonic; that is, -it follows Python's conventions very nicely (code is sparse and clean). - -Contrast this with J2EE and Python's most popular and visible web frameworks: -Django, Zope, Pylons, and Turbogears. In all of them, the learning curve is -massive. In these frameworks, "Hello, world" requires the programmer to set -up a large scaffold which spans multiple files and to type a lot of boilerplate -code. CherryPy succeeds because it does not include the bloat of other -frameworks, allowing the programmer to write their web application quickly -while still maintaining a high level of organization and scalability. - -CherryPy is also very modular. The core is fast and clean, and extension -features are easy to write and plug in using code or the elegant config -system. The primary components (server, engine, request, response, etc.) -are all extendable (even replaceable) and well-managed. - -In short, CherryPy empowers the developer to work with the framework, -not against or around it. - -2. Power --------- - -CherryPy leverages all of the power of Python. Python is a dynamic language -which allows for rapid development of applications. Python also has an -extensive built-in API which simplifies web app development. Even more -extensive, however, are the third-party libraries available for Python. These -range from object-relational mappers to form libraries, to an automatic Python -optimizer, a Windows exe generator, imaging libraries, email support, HTML -templating engines, etc. CherryPy applications are just like regular Python -applications. CherryPy does not stand in your way if you want to use these -brilliant tools. - -CherryPy also provides Tools and Plugins, which are powerful extension points -needed to develop world-class web applications. - -3. Maturity ------------ - -Maturity is extremely important when developing a real-world application. -Unlike many other web frameworks, CherryPy has had many final, stable releases. -It is fully bugtested, optimized, and proven reliable for real-world use. -The API will not suddenly change and break backwards compatibility, so your -applications are assured to continue working even through subsequent updates -in the current version series. - -CherryPy is also a "3.0" project: the first edition of CherryPy set the tone, -the second edition made it work, and the third edition makes it beautiful. -Each version built on lessons learned from the previous, bringing the developer -a superior tool for the job. - -4. Community ------------- - -CherryPy has an active community that develops deployed CherryPy applications -and are willing and ready to assist you on the CherryPy mailing list or IRC. -The developers also frequent the list and often answer questions and implement -features requested by the end-users. - -5. Deployability ----------------- - -Unlike many other Python web frameworks, there are cost-effective ways to -deploy your CherryPy application. - -Out of the box, CherryPy includes its own production-ready HTTP server -to host your application. If the application needs to be deployed on Apache, -there is copious documentation discussing how to connect the two. CherryPy can -also be deployed on any WSGI-compliant gateway (a technology for interfacing -numerous types of web servers): mod_wsgi, FastCGI, SCGI, IIS, etc. - -In addition, CherryPy is pure-python and is compatible with Python 2.3. This -means that CherryPy will run on all major platforms that Python will run on -(Windows, MacOSX, Linux, BSD, etc). - -`Webfaction.com <http://www.webfaction.com>`_, run by the inventor of CherryPy, -is a commercial web host that offers CherryPy hosting packages (in addition to -several others). - -6. It's free! -------------- - -All of CherryPy is licensed under the open-source BSD license, which means -**CherryPy can be used commercially for ZERO cost**. - -7. Where to go from here? -------------------------- - -Check out the :doc:`/concepts/index` and :doc:`/progguide/index` for -more complete documentation. - |