]> scripts.mit.edu Git - wizard.git/blob - README
Rename lib/wizard to wizard for compactness.
[wizard.git] / README
1 This is Python 2.6 only!
2
3 To add a new command to wizard, you need to touch the following
4 locations:
5
6 - bin/wizard
7     Add a line describing your command in the helpstring
8 - wizard/command/__init__.py
9     Add the line "import commandname"
10 - wizard/command/commandname.py
11     Implement your command there as main(). Copy the function
12     signature and scaffolding from another file; it's non-trivial
13
14 Design decision:
15 - A mass tool will plow ahead even if the subcommand throws
16   Wizard errors.  Normal errors will cause us to halt
17   completely.  If the error that occured is within the realm
18   of possibly, and should be dealt with by manual intervention
19   (or even possibly a code change), and would not cause harm
20   if we continued going, we will keep going, and let the maintainer
21   deal later on with the errors en masse.