Re: [jokosher-devel] Planning 0.2

[Stephen Thorne <stephen thorne id au>]

On Sun, 16 Jul 2006 23:44:34 -0400, Laszlo Pandy <laszlok2 gmail com> wrote:
> Stephen Thorne wrote:
> > As a python programmer who'd like to hack on jokosher, the first thing I 
> > noted when I checked it out from subversion was the rather non-standard
> > file-naming and odd style.
> >
>
> Nice file structure might be nice, but is it really that important?

Yes. It's the difference between having an extensible python application that can be extended cleanly, and a bunch of files that you have to rape+paste or monkeyhack in order to use them externally.

Use case: Alternate tool, based on jokosher's libraries, in order to import jokosher libraries, that tool will have to have every single module named differently, and will have to use sys.path hacks to import jokosher.

If the libs are instead done nicely into a package, it would be trivial to import jokosher libs and mix them with my own code, as jokosher could live in site-packages/jokosher/.

> > For 0.2, it'd be nice to have a clear, and rigerously followed, project
> > styleguide published. Currently there's some source that uses tabs, some
> > uses spaces (JokDebug.py and Waveform.py are pure-space) and
> > capitalisation doesn't follow PEP-8's guidelines.
> >
>
> Actually, JokDebug.py is just a debugging tool and not part of the code. 
> Waveform.py is just a demonstration and doesn't really belong in SVN anyway. 
> I am pretty sure I have made sure there are spaces in all the others.
>
> As for capitalisation, is there really a "right" way to do it?

Yep. PEP-8 has clear guidelines on the topic of naming conventions: http://www.python.org/dev/peps/pep-0008/

Stephen.