Mercurial > hg > genshi_view

annotate README.txt @ 22:f088f0b54b55 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
py3
author Jeff Hammel <k0scist@gmail.com>
date Tue, 03 Nov 2020 08:42:44 -0800
parents cf19d2e129de
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
20
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
1 Setting Up A New Project
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
2 ========================
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
3
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
4 from start to editing code
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
5
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
6 0. Install virtualenv [Optional but highly recommended]::
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
7
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
8 easy_install virtualenv
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
9
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
10 1. Make a virtualenv::
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
11
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
12 virtualenv myproject
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
13
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
14 2. Install genshi_view::
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
15
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
16 cd myproject
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
17 . bin/activate
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
18 mkdir src
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
19 cd src
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
20 hg clone http://k0s.org/hg/genshi_view # or `easy_install genshi_view`
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
21 cd genshi_view
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
22 python setup.py develop
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
23 cd ..
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
24
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
25 3. Instantitate a template. genshi_view is a pastescript template
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
26 that will get you a hello world application OOTB::
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
27
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
28 paster create -t genshi_view your_project_name
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
29
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
30 Answer the questions it asks you regarding the template variables.
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
31
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
32 4. Serve your application to see that it works::
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
33
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
34 cd your_project_name
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
35 paster serve your_project_name.ini
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
36
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
37 Navigate to the URL that paster displays
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
38
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
39 5. You're done! Helloworld works. Now you just have to edit the
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
40 source code:
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
41
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
42 - templates are in your_project_name/templates; there is one by default
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
43 - static resources are in your_project_name/static
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
44 - the request dispatcher is at your_project_name/dispatcher
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
45 - the request handlers are at your_project_name/handlers; if you add
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
46 more, don't forget to add them to dipatcher.py's imports and to
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
47 self.handlers in Dispatcher's __init__ function
cf19d2e129de adding a basic README telling how to use
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
48