Metadata-Version: 1.0
Name: RapidGiza
Version: 0.1.2
Summary: Set of paster templates for rapid Pyramid development
Home-page: http://dist.serverzen.com/pypi/d/rapidgiza/
Author: Rocky Burt
Author-email: rocky@serverzen.com
License: UNKNOWN
Description: .. -*-rst-*-
        
        Introduction
        ============
        
        RapidGiza is a set of Paster templates that provide out of the box:
        
          * An application based on the Pyramid_ web application framework
        
          * Default SQLAlchemy_ engine/session-factory setup
        
          * All ``.html`` files matched as Jinja2_ templates
        
          * Werkzeug_ setup for running the app in development mode
        
          * RESTful_ setup using Pyramid traversal
        
        Important URL's
        ---------------
        
          * Project Location - http://dist.serverzen.com/pypi/d/rapidgiza/
        
          * PyPi Entry - http://pypi.python.org/pypi/RapidGiaz
        
          * Source Control (svn) - https://dev.serverzen.com/svn/public-sandbox/RapidGiza/
        
        Setting up a New Project
        ========================
        
        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
        
        Using the New Project
        =====================
        
        Command Runner
        --------------
        
        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::
        
          usage: something <action> [<options>]
                 something --help
          
          actions:
            runserver:
              Run the development server.
              
              :param debug: run in debug mode
              :param verbosity: increase level of logging for more verbose logging
          
              -h, --hostname                string    0.0.0.0
              -p, --port                    integer   8080
              -d, --debug
              -v, --verbosity               integer   0
          
            syncdb:
              Ensure tables exist in the configured database.
        
        Paster
        ------
        
        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
        
        Apache mod_wsgi
        ---------------
        
        There is a preconfigured ``Something.wsgi`` file generated which
        is necessary for plugging your app into a mod_wsgi environment.
        
        Developing With the New Project
        ===============================
        
        Base Framework
        --------------
        
        RapidGiza is based on the amazing Pyramid_ web application
        framework.  As such, the Pyramid_ api will always be
        the go-to api for building up the web application.  Please
        see the `Pyramid docs`_ for further details.
        
        Templating
        ----------
        
        Any file ending with the ``.html`` 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.
        
        Data Access
        -----------
        
        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.
        
        Developing/Debugging
        --------------------
        
        The Werkzeug_ library is used to provide two things:
        
          1. A very useful debugging middleware
        
          2. A command runner
        
        Credits
        =======
        
        RapidGiza is written and maintained by Rocky Burt
        (rocky AT serverzen DOT com).
        
        .. _Jinja2: http://jinja.pocoo.org/
        .. _Pyramid: http://docs.pylonshq.com/
        .. _`Pyramid Docs`: http://docs.pylonshq.com/pyramid/dev/
        .. _Werkzeug: http://werkzeug.pocoo.org/
        .. _SQLAlchemy: http://www.sqlalchemy.org/
        .. _orm: http://en.wikipedia.org/wiki/Object-relational_mapping
        .. _virtualenv: http://pypi.python.org/pypi/virtualenv
        .. _RESTful: http://en.wikipedia.org/wiki/Representational_State_Transfer
        
        
        .. -*-rst-*-
        
        Changes
        =======
        
        0.1.2 - Nov 29, 2010
        --------------------
        
          * Changed ``make_app()`` signature
        
          * Added development.ini for out-of-the-box use with Paster serve
        
          * Generated projects now include two Paster apps
        
            1. <<project>>:app - Web app with included middleware
        
            2. <<project>>:pyramid-app - Web app without middleware 
        
        0.1.1 - Nov 29, 2010
        --------------------
        
          * Fixed MANIFEST.in so sdist contains appropriate files
        
        0.1 - Nov 29, 2010
        ------------------
        
          * Initial version
        
Keywords: web wsgi bfg pylons pyramid
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
