PyFitz is our shared package for random utility modules which we make and want to keep together.
To get source:
darcs get http://rkd.zgib.net/http/code/fitz/
To send source:
darcs record # say 'y' to whichever patches you want to include (try to group them in an organized fashion) # author format: "Your Name <email@example.com" # enter a descriptive title # enter a long comment (what is improved? what is added?) I used a bulleted list format # rsync the directory over to a web server where richard can grab the changes
Standards for inclusion
It's better to commit something that works, than not commit at all.
Include things if there is a remote chance someone else might use them. But, if it's so abstract most people wouldn't get what it's about, maybe best to not include it (or keep it in your private repo). The goal of this package is to have one set of useful tools that we can install on other systems, and not have to transfer lots of little things separately.
- Have an minimal documentation - at least enough to a) figure out what the module is supposed to do b) explain what methods are supposed to be called in what order.
- Include your name and year/month of initial creation. Add your name if you modify.
- Maintain backwards compatibility (especially when modifying someone else's modules)
- Some test cases are nice. They don't have to be through, but something that gives an example of how it's used are good.
- If it's a utility program, python -m fitz.modulename can be used to run it as a script
- Include license "GPLv2+" or something.
List of modules
fitz.interact: improved version of code.interact
- Automatically executes in the calling scope
- Loads the readline buffer with the code above in the file.
fitz.cliargs: Easy, lightweight, command line argument processing.