Metadata-Version: 1.0
Name: tgcrud
Version: 1.0Beta
Summary: Genrate CRUD interface in TurboGears
Home-page: docs.turbogears.org
Author: Fred Lin
Author-email: gasolin+tg@gmail.com
License: UNKNOWN
Download-URL: http://www.python.org/pypi/tgcrud/
Description: 
        tgcrud is a 'no magic' crud (create, read, update, delete)
        interface generator, the generated codes are fully customizable.
        tgcrud heavily use form widgets and show you many
        TG 1.0 features in it's controllers/templates.
        
        tgcrud could generate sqlobject/sqlalchemy based crud interface with kid template.
        It could be plugged into any projects even if you don't use kid template.
        
        If you are a TG beginer, tgcrud help you create a general
        admin skeleton based on your model.
        
        If you are an experienced TG developer, you could get it in minutes
        since it just done the basic procedure that every time you write a
        management interface of your model.
        
        
        Install
        ----------
        
        The 'tgcrud' command extension is available in Python CheeseShop and
        TurboGears svn.
        
        You can use setuptools to install tgcrud with following command::
        
        
        $ easy_install tgcrud
        
        or download the source code and install tgcrud manually.
        
        Screencast
        --------------
        
        Yes, there's a 'Make a Book Site with TurboGears' screencast with tgcrud.
        
        If you are an experienced TG developer, you could watch the third one directly.
        
        If you are new to TG, you may want to watch all of them in sequence.
        
        - Quickstart TurboGears project, 6.5MB
        
        http://files.turbogears.org/video/openbook1.swf
        
        - Design model with toolbox utilities, 7.7MB
        
        http://files.turbogears.org/video/openbook2.swf
        
        - tgcrud, the TG's scaffold, 5.2 MB
        
        http://files.turbogears.org/video/openbook3.swf
        
        With tgcrud you could easily generate a Rails scaffold
        style CRUD interface. The difference is all code in tgcrud is
        implicit, which leads a more easy customization.
        
        Usage
        ----------
        1. Define your model in model.py
        
        2. After you've defined your model,
        you could use "tg-admin crud" command to generate the crud pack.
        The syntax is::
        
        $ tg-admin crud [model class name] [package name]
        
        e.x if the model name is BookMark,
        the package name is BookMarkController, the command is::
        
        $ tg-admin crud BookMark BookMarkController
        
        Then the 'admin' package is generated.
        You just need take several minutes to customize the formfield to
        have a proper crud interface.
        
        ..note:: you could estimate the result by passing "--dry-run" to the command, such as::
        
        $ tg-admin crud BookMark BookMarkController --dry-run
        
        With this argument the command will not effect your physical directories.
        
        
        3. Import the package to your controllers.py with a line:
        
        from BookMarkController import BookMarkController
        
        and add a branch on your Root()::
        
        foo = BookMarkController()
        
        4. Customize the form filed in admin/controllers.py
        
        5. Open the http://localhost:8080/foo to use the customizable interface.
        
        Please refer to http://docs.turbogears.org/1.0/CRUDTemplate for detail
        
        ChangeLog for 1.0
        -------------------------
        * generated code set parameter literaly in save method
        * 'import session' now only shows on SA template
        * sqlalchemy db auto detection
        * add --dry-run element
        
        
        
Keywords: turbogears.command
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Framework :: TurboGears
