Metadata-Version: 1.0
Name: blueberrypy
Version: 0.5
Summary: CherryPy plugins and tools for integration with various libraries, including logging, Redis, SQLAlchemy and Jinja2 and webassets.
Home-page: http://bitbucket.org/wyuenho/blueberrypy
Author: Jimmy Yuen Ho Wong
Author-email: wyuenho@gmail.com
License: BSD
Description: BlueberryPy
        ===========
        Same as CherryPy, just with a different filling.
        
        
        
        What is it?
        -----------
        BlueberryPy is a CherryPy project skeleton generator and a collection of tools,
        plugins and utilities for `CherryPy <http://cherrypy.org/>`_ - the minimalist
        Python web framework.
        
        
        What does it offer?
        -------------------
        BlueberryPy is offered as a set of CherryPy tools, WSPB plugins and extra utility
        modules. All the components are optional and completely pluggable without any
        intermodule dependencies, so you can safely pick and choose just the components
        you want.
        
        - SQLAlchemy ORM plugin with two-phase commit support
        - Per-request SQLAlchemy ORM session tool
        - Redis session storage
        - Jinja2 template engine
        - Webassets asset pipeline integrated with Jinja2
        - Application specific logging
        - CherryPy project skeleton generator
        - Preconfigured console for experimenting inside a generated project
        - YAML configuration for CherryPy, Python's logging module and Webassets
        - Convenient Email module for sending text and HTML emails
        - JSON tools to convert to and from SQLAlchemy models
        - CSRF token
        
        
        Installation
        ------------
        
        Stable version::
        
           $ pip install blueberrypy
        
        Development version::
        
           $ pip install https://bitbucket.org/wyuenho/blueberrypy
        
        
        Note: You should probably install it inside a `virtualenv <http://www.virtualenv.org/>`_.
        
        
        Usage
        -----
        
        Once BlueberryPy is installed, a script called `blueberrypy` should be available on
        your PATH.
        
        ::
        
          usage: blueberrypy [-h] [-v] [-C CONFIG_DIR] [command]
        
          BlueberryPy lightweight pluggable Web application framework command line interface.
        
             Type 'blueberrypy -h' or 'blueberrypy --help' for general help.
             Type 'blueberrypy help <command>' for help on that specific command.
        
          commands:
        
             help                print this help or a command's if an argument is given
             create              create a project skeleton
             console             BlueberryPy REPL for experimentations
             bundle              bundles up web assets (type 'blueberrypy help bundle' for details)
             serve               spawn a new CherryPy server process
        
          positional arguments:
             command               the action to perform
        
          optional arguments:
             -h, --help            show this help message and exit
             -v, --version         print version information and exit.
             -C CONFIG_DIR, --config_dir CONFIG_DIR
                                   path to the config directory
        
        
        To create a project skeleton::
        
           $ blueberrypy create
        
        After you've answered a couple of questions, you should see something similar to
        this::
        
           ===========================================================================
           Your project skeleton has been created under /path/to/your/project .
           
           
           Subsystems chosen
           -----------------
           Routes (RESTful controllers): True
           Jinja2: True
           webassets: True
           redis: False
           SQLAlchemy: True
           ...
        
        
        If you install a development version of your package now, the dependencies will
        be automatically installed for you as well::
        
           $ pip install -e .
        
        You can install the optional speedup packages too::
        
           $ pip install blueberrypy[speedups]
        
        Finally, you need to install a database driver such as `psycopg2`::
        
           $ pip install psycopg2
        
        Now your package is ready to be served::
        
           $ blueberrypy serve
        
        Type `http://localhost:8080` into your browser's location bar and voila!
        
        Happy coding!
        
        TODO
        ----
        
        #. write sphinx doc
        #. minimalist, conditional validators for json utils and form inputs
        #. babel integration
        #. request handler cache decorator
        #. search engine integration
        #. alembic or sqlalchemy-migrate integration
        #. modularize skeleton generation and commands
        #. better test coverage
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Plugins
Classifier: Environment :: Web Environment
Classifier: Framework :: CherryPy
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Database
Classifier: Topic :: Internet :: WWW/HTTP :: Session
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
