Set of paster templates for rapid Pyramid development
RapidGiza is a set of paster templates for rapid Pyramid development. It makes several framework choices for the developer which are:
Install RapidGiza into a Python environment (ie virtualenv) with a working Paster. Once this has been done, you can create a new RapidGiza project by simply running (where Something is the name of your new egg):
paster create -t rapidgiza Something
Once the template egg has been created you should set it up in develop mode to start working on your project.
cd Something python setup.py develop
By default a new script named something will be created in the bin directory of your python envionment. This script is a command runner that provides the following:
Commands: runserver Run a reloadable development web server.
A development.ini file will be created inside the Something directory. This can be used with the standard paster commands:
# use builtin paster http server paster serve development.ini # use the pyramid pshell command paster --plugin=pyramid pshell development.ini pyramid-Something
There is a preconfigured Something.wsgi file generated which is necessary for plugging your app into a mod_wsgi environment.
A simple apache virtualhost entry will look like this:
<VirtualHost *:80> ServerName www.something.com WSGIScriptAlias / /path/to/Something.wsgi </VirtualHost>
RapidGiza is based on the Pyramid web application framework. As such, the Pyramid api will always be the go-to api for working with the web application. Please see the Pyramid docs for further details.
Any file ending with the .jinja2 extension located inside the Something/something/templates directory will be rendered using the Jinja2 templating system. This template language is based on the Django templating language.
RapidGiza produces two template files by default, one containing the overall layout called, layout.jinja2 and one for the default main page called, main.jinja2.
All data access is handled by the SQLAlchemy ORM framework which wraps relational databases. Out of the box, any new project created by RapidGiza will have a SQLAlchemy database session factory setup.
RapidGiza puts the orm model classes inside the models.py Python file. The active database session can always be retrieved as the db attribute on the request object.
RapidGiza ensures all requests join a new transaction so that if any error/exception occurs, the transaction is automatically rolled back. Any db sessions created via the provided session factory automatically join this transaction and will be rolled back in the event an error occurs.
The Pyramid web application framework provides a convenient mechanism to traverse an object graph and map that graph to url’s. RapidGiza stores it’s traversal mechanism inside of the traversal.py file.
- Created and maintained by Rocky Burt (rocky AT serverzen DOT com)
- Updated url’s to point to github repo
- switched from Werkzeug to Khufu-Script
- now using Khufu-SQLAHelper
- yet another missing file (won’t happen again)
- Added yet another missing file to MANIFEST.in
- Changed make_app() signature
- Added development.ini for out-of-the-box use with Paster serve
- Generated projects now include two Paster apps
- <<project>>:app - Web app with included middleware
- <<project>>:pyramid-app - Web app without middleware
- Fixed MANIFEST.in so sdist contains appropriate files
- Initial version