Hi. Welcome to Paste. I hope you enjoy your stay here.
I hope to bring together multiple efforts here, for Paste to support multiple frameworks and directions, while presenting a fairly integrated frontend to users. How to do that? That’s an open question, and this code is in some ways an exploration.
There’s some basic principles:
Mostly, if there’s a problem we can discuss it and work it out, no one is going to bite your head off for committing something.
If you move something around that someone may be using, keep their imports working and introduce a warning, like:
def backward_compat_function(*args, **kw): import warnings # Deprecated on 2005 Mar 5 warnings.warn('Moved to foo.function', DeprecationWarning, 2) return foo.function(*args, **kw)
If something is really experimental, put it in your home directory, or make a branch in your home directory. You can make a home directory for yourself, in http://svn.w4py.org/home/username.
Not everything in the repository or even in the trunk will necessarily go into the release. The release should contain stuff that is tested, documented, and useful. Each module or feature also needs a champion – someone who will stand by the code, answer questions, etc. It doesn’t have to be the original developer, but there has to be someone. So when a release is cut, if some modules don’t fulfill that they may be left out.
Try to keep to the Style Guidelines. But if you are bringing in outside work, don’t stress out too much about it. Still, if you have a choice, follow that. Those guidelines are meant to represent conventional Python style guides, there’s nothing out of the normal there.
Write your docstrings in restructured text. As time goes on, I want to rely on docstrings more for documentation, with shorter narrative documentation pointing into the documentation generated from docstrings.
The generation is done with Pudge. To try generating the documentation, this should work:
$ easy_install svn://lesscode.org/buildutils/trunk \ svn://lesscode.org/pudge/trunk $ cd Paste $ python setup.py pudge
This will install Pudge and buildutils, and then generate the documentation into Paste/docs/html/.