<commit_before>.. Pecan documentation master file, created by
   sphinx-quickstart on Sat Oct  9 14:41:27 2010.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Pecan's documentation
=========================

A WSGI object-dispatching web framework, in the spirit of TurboGears, only 
much much smaller, with many fewer dependencies.


Contents:

.. toctree::
   :maxdepth: 2

   quick_start.rst 
   routing.rst 
   configuration.rst 
   templates.rst 
   hooks.rst 
   jsonify.rst 
   secure_controller.rst 
   validation_n_errors.rst
   app_engine.rst


Introduction
============
Pecan packs a few good features but it is also extremely lean, it requires just
a few dependencies but for the most part it feels like a full fledged web
framework!

 * Object-Dispatch for easy routing
 * Pre and Post Hooks 
 * REST controllers 
 * Validation and Error handling
 * Secure controllers
 * Template language support
 * AppEngine out of the box (no patching!)



Pecan Hello World
------------------
In this example we use ``httpserver`` from ``paste`` but feel free to use any 
WSGI server you want::

    from paste import httpserver
    from pecan import make_app, expose


    class RootController(object):

        @expose()
        def index(self):
            return 'Hello, World!'

    app = make_app(RootController(), debug=True)
    httpserver.serve(app, host='0.0.0.0', port=8080)

License
-------
The Pecan framework and the documentation is BSD Licensed::

    Copyright (c) <2010>, <Pecan Framework>
    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 <organization> 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<commit_msg>adding sub-sections for proper API, Tutorials and main docs<commit_after>.. Pecan documentation master file, created by
   sphinx-quickstart on Sat Oct  9 14:41:27 2010.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Pecan's documentation
=========================

A WSGI object-dispatching web framework, in the spirit of TurboGears, only 
much much smaller, with many fewer dependencies.


Contents:

.. toctree::
   :maxdepth: 2

   installtion.rst
   routing.rst 
   configuration.rst 
   templates.rst 
   hooks.rst 
   jsonify.rst 
   secure_controller.rst 
   validation_n_errors.rst


Introduction
============
Pecan packs a few good features but it is also extremely lean, it requires just
a few dependencies but for the most part it feels like a full fledged web
framework!

 * Object-Dispatch for easy routing
 * Pre and Post Hooks 
 * REST controllers 
 * Validation and Error handling
 * Secure controllers
 * Template language support
 * AppEngine out of the box (no patching!)



Pecan Hello World
------------------
In this example we use ``httpserver`` from ``paste`` but feel free to use any 
WSGI server you want::

    from paste import httpserver
    from pecan import make_app, expose


    class RootController(object):

        @expose()
        def index(self):
            return 'Hello, World!'

    app = make_app(RootController(), debug=True)
    httpserver.serve(app, host='0.0.0.0', port=8080)


Tutorials
=========
We provide a couple of easy ways to get started including a short tutorial on
App Engine.

.. toctree::
   :maxdepth: 2

   quick_start.rst 
   app_engine.rst


API
===
The following section lists the main sections of Pecan, where you can find more
specific details about methods and modules available.

.. toctree::
   :maxdepth: 2

   decorators.rst 
   hooks.rst 
   jsonify.rst 
   pecan.rst 
   rest.rst 
   routing.rst 
   secure.rst
   templating.rst

License
-------
The Pecan framework and the documentation is BSD Licensed::

    Copyright (c) <2010>, <Pecan Framework>
    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 <organization> 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
{'fraction_non_alphanumeric': 0.072570504760194, 'fraction_numerical': 0.008981498113885397, 'mean_word_length': 3.183320811419985, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 2, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1419282', 'n_tokens_mistral': 1521, 'n_tokens_neox': 1365, 'n_words': 676}