A scenario -- You've generated a module with generateDS.py and worked with it a bit. It seems to work and to be helpful. So, you wonder, how could I package this up so that others can learn about it and use it. Perhaps you want to include a few examples, maybe even a utility module that helps use it. And, you think, wouldn't it be great if I could generate documentation for the API (the classes and methods) that is exposed by my generated module.
And, since you've been using Open Source code for some time now, you ask yourself: I wonder, has anyone has done this kind of thing before? Yes, they have. Roy Williams showed me the way on this. I simply copied what he has done with VOEvents (see https://betelgeuse.ligo.caltech.edu/VOEventLib/) and "templatized" it and added some instructions on how to use the template to create a custom package. There is no need to feel disappointed that there is nothing left for you to do. After you have used this "template" to create your package, you can have fun by adding utility functions and by including some sample XML instance docs and by writing a few sample Python scripts that demonstrate the use of the generated module. Even if you do not plan to pass your generated module on to someone else, you might still want to use this template to create a package, if for no other reason than that it is an easy way to generate documentation for your module. You'll need Sphinx in order to do this (see http://sphinx.pocoo.org/), and it also helps, but is not essential, if your schema contains documentation on the elements and types it defines (the <annotation><documentation> stuff). Again, thanks to Roy Williams for showing me the way on this. I've tried using this several times, and it *seems* usable and useful. But, I'd welcome any suggestions about how to improve it. I'll add something to the generateDS.py documentation later, but in the meantime, the instructions are here: http://www.rexx.com/~dkuhlman/schema_package_howto.html and the template package itself is here: http://www.rexx.com/~dkuhlman/librarytemplate0-1.0a.zip - Dave -- Dave Kuhlman http://www.rexx.com/~dkuhlman ------------------------------------------------------------------------------ This SF.net email is sponsored by Make an app they can't live without Enter the BlackBerry Developer Challenge http://p.sf.net/sfu/RIM-dev2dev _______________________________________________ generateds-users mailing list generateds-users@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/generateds-users
