[Parti-discuss] Newbie - Want to understand the code (and Help...)

[Nathaniel Smith]

On Wed, Dec 23, 2009 at 9:04 PM, Fernando Governatore <fergc at uol.com.br> wrote:
> I've just found this project and this is what i was dreaming for sooo long
> that I can't remember...
> I want to try to help with the code, is there any advice on how to
> understand the program?
> Are there any docs about the code?(I couldn't find, but have not tried very
> hard also...)

There isn't much in the way of code docs, beyond comments in the
source. Personally, I've eventually come to the opinion that if I need
source code docs, then either the source is too complicated or I need
to improve my source reading skills, though of course YMMV.

Basic organization is:
  wimpiggy/ is a library for writing window managers in Python. It
assumes you're familiar with GTK+ api conventions, and with how window
managers and X11 work. If you don't know how WM's and X11 work, then
working-notes/specs.txt may be helpful. See also README.wimpiggy for a
start.

  xpra/client.py and xpra/server.py are the main xpra client/server
code. They rely on xpra/protocol.py and some other utility code in
xpra/ to work, and are probably the place to start if you want to get
a handle on the basic working of xpra.

  xpra/scripts/main.py and xpra/scripts/server.py implement the
command line that you actually end up interacting with.

-- Nathaniel