stackforge/pecan
Code Issues Proposed changes

More documentation stubs.

Browse Source
This commit is contained in:
Ryan Petrello
2012-03-13 17:34:36 -07:00
parent e27e1ee51d
commit b5b938a5b8
2 changed files with 38 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

82
docs/source/deployment.rst
View File

@@ -1,7 +1,7 @@
.. _deployment: .. _deployment:
Deployment Recipes Deploying Pecan in Production
================== =============================
Deploying a pecan project can be accomplished in several ways. You may Deploying a pecan project can be accomplished in several ways. You may
already be familiar with deployment methodologies for other Python already be familiar with deployment methodologies for other Python
@@ -11,70 +11,22 @@ standards laid out by similar Python web frameworks before it.
Here we will outline some of the common methods for deploying your Pecan Here we will outline some of the common methods for deploying your Pecan
project. project.
Good ol' fashioned source control. mod_wsgi
----------------------------------- --------
TODO
Why not? It works! In our modern world of distributed SCM tools, we find FastCGI
using source control as a completely acceptable method for deployment. -------
Sure it's a bit more manual than you might like, but it gets the job TODO
done, and rollbacks are free (if you're into that kind of thing ;)). For
this guide, it is assumed you are developing your application in a git
repository.
Here are some tips, free of charge:: uWSGI
-----
TODO
* Develop on "feature" branches. Tornado
* All merge back to "master" when sprint is complete. -------
* Tag "release" branches. TODO
To setup:: Gunicorn
--------
* git clone <project> /opt/project/ TODO
* git branch --track <release_branch> origin/<release_branch>
* git checkout <release_branch>
* python setup.py install
To deploy going forward::
* cd /opt/project/
* git pull
* git branch --track <release_branch> origin/<release_branch>
* git checkout <release_branch>
* python setup.py install
That should do it.
Fabric
------
Fabric makes it way more fun to deploy. You can write straight up python
to automate the SCM deployments, or even go so far as to build a full fledged
release system with it.
Capistrono
----------
Much like fabric, but they built in some out of the box deployment
tools. We'll cover that here.
Chef
----
Chef borrows it's deployment methodologies from Capistrono, we'll cover
that here.
Whiskey Disk
------------
The embarrassingly fast deployment tool. Decoupled from frameworks, one
specific design goal, to deploy quickly and easily. YAML configuration.
Egg
---
Deploy binary packages using python's distribution utilities.
RPM
---
Deploy your apps with RPM's, built with python's distribution utilities.

21
docs/source/forms.rst
View File

@@ -2,4 +2,25 @@
Generating and Validating Forms Generating and Validating Forms
=============================== ===============================
Out of the box, Pecan provides no opinionated support for working with
form generation and validation libraries, but it’s easy to hook into your
library of choice with minimal effort.
This article details best practices for integrating the popular forms library,
WTForms, into your Pecan project.
Defining a Form Definition
--------------------------
TODO
Rendering a Form in a Template
------------------------------
TODO
Validating POST Values
----------------------
TODO
Further Documentation
---------------------
TODO TODO