Mercurial > hg > genshi_view
changeset 20:cf19d2e129de
adding a basic README telling how to use
author | Jeff Hammel <jhammel@mozilla.com> |
---|---|
date | Wed, 05 May 2010 11:59:39 -0700 |
parents | 4a5b542a638c |
children | 807c8eef8098 |
files | README.txt setup.py |
diffstat | 2 files changed, 55 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README.txt Wed May 05 11:59:39 2010 -0700 @@ -0,0 +1,48 @@ +Setting Up A New Project +======================== + +from start to editing code + +0. Install virtualenv [Optional but highly recommended]:: + + easy_install virtualenv + +1. Make a virtualenv:: + + virtualenv myproject + +2. Install genshi_view:: + + cd myproject + . bin/activate + mkdir src + cd src + hg clone http://k0s.org/hg/genshi_view # or `easy_install genshi_view` + cd genshi_view + python setup.py develop + cd .. + +3. Instantitate a template. genshi_view is a pastescript template +that will get you a hello world application OOTB:: + + paster create -t genshi_view your_project_name + +Answer the questions it asks you regarding the template variables. + +4. Serve your application to see that it works:: + + cd your_project_name + paster serve your_project_name.ini + +Navigate to the URL that paster displays + +5. You're done! Helloworld works. Now you just have to edit the +source code: + + - templates are in your_project_name/templates; there is one by default + - static resources are in your_project_name/static + - the request dispatcher is at your_project_name/dispatcher + - the request handlers are at your_project_name/handlers; if you add + more, don't forget to add them to dipatcher.py's imports and to + self.handlers in Dispatcher's __init__ function +
--- a/setup.py Sun Jan 24 12:50:12 2010 -0500 +++ b/setup.py Wed May 05 11:59:39 2010 -0700 @@ -1,12 +1,16 @@ from setuptools import setup, find_packages -version = '0.3.1' +try: + description = file('README.txt').read() +except IOError: + description = '' + +version = '0.3.2' setup(name='genshi_view', version=version, description="paste template for a view using webob + genshi", - long_description="""\ -""", + long_description=description, classifiers=[], # Get strings from http://www.python.org/pypi?%3Aaction=list_classifiers keywords='', author='Jeff Hammel',