Tepache
                     -------
Author:
    Sandino "tigrux" Flores-Moreno
Email:
    tigrux_at_ximian_dot_com
Current version:
    1.1
Release date:
    Jul 4 2005
                     

License
-------

This program is covered by the LGPL.


A spanish soup and a mexican beverage
-------------------------------------

The gazpacho is a soup made of fresh tomatoes.
It is commonly prepared and drinken in summer in Spain, when spanish are
thirsty and want to get fresh.

The tepache is a mexican beverage made of brewed pineapple.
It is commonly prepared and drinken in summer in Mexico, when mexicans are
thirsty and want to get cool.

gazpacho is also the name of a designer of graphical interfaces, that started
in Spain (AFAIK), and compatible with glade. So, naming this program as
tepache is very convenient since the similarities in the meaning of both names.
Guess where I am from? :-) 

                     
What is tepache?
----------------

Tepache is a code sketcher for python that uses pygtk and glade.
It could look like other glade codegens, but it is totally different.
Not glade codegen but a code sketcher

Not glade codegen but a code sketcher
-------------------------------------

There is libglade, there is pygtk-libglade. Then, tepache does not have to
create any code for creating the graphical interfaces.
It creates pure python modules with classes that are clean abstractions for
the toplevel widgets of the glade files.
That is why we say tepache is not a code generator, it is a code sketcher.

Typical code generators overwrite your own code every time they are executed.
Tepache won't lost your code because it uses a very simple system of using
context comments for protecting your code. It could look a little verbose
but works very well.


Supported platforms
-------------------

It will run un any platform with python 2.3+, patch and diff.
It has been tested in GNU/Linux, Windows and MacOSX.
For running in Windows you need to install patch and diff from
gnuwin32 [http://gnuwin32.sourceforge.net/packages.html]
and pywin32 extensions [http://sourceforge.net/projects/pywin32]


Install
-------

Just download tepache, chmod it to 0755 and use it as any other executable script.

It can optionally be integrated to glade by applying a patch for glade

A tarball provides all the required files as well an installer based on distutils.
Runnin python setup.py will install it.

Rpms of glade compiled in Mandrake and tested in Ubuntu are also provided. 


Usage
----------------

[tigrux@garritas tepache]$ tepache
usage: tepache [options] [GLADE_FILE] [OUTPUT_FILE]

write a sketch of python code from a glade file.

options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -g GLADE_FILE, --glade=GLADE_FILE
                        file to parse
  -o OUTPUT_FILE, --output=OUTPUT_FILE
                        file to write the sketch of the code
  -n, --no-helper       Do not write the helper module
  -t, --use-tabs        Use tabs instead of 4 spaces for indenting. Discouraged according to PEP-8.

[tigrux@garritas tepache]$ tepache sample.glade
written file sample.py
			
Generated sketch of code
--------------

sample.py

#!/usr/bin/env python
# -*- coding: UTF8 -*-

# Python module sample.py
# Autogenerated from sample.glade
# Generated on Sat Jul  2 23:59:38 2005

# Warning: Do not modify any context comment such as #--
# They are required to keep user's code

import os

import gtk
import gnome

from SimpleGladeApp import SimpleGladeApp
from SimpleGladeApp import bindtextdomain

app_name = "sample"
app_version = "0.0.1"

glade_dir = ""
locale_dir = ""

bindtextdomain(app_name, locale_dir)


class MainWindow(SimpleGladeApp):

    def __init__(self, path="sample.glade",
                 root="main_window",
                 domain=app_name, **kwargs):
        path = os.path.join(glade_dir, path)
        SimpleGladeApp.__init__(self, path, root, domain, **kwargs)

    #-- MainWindow.new {
    def new(self):
        print "A new %s has been created" % self.__class__.__name__
    #-- MainWindow.new }

    #-- MainWindow custom methods {
    #   Write your own methods here
    #-- MainWindow custom methods }

    #-- MainWindow.on_button1_clicked {
    def on_button1_clicked(self, widget, *args):
        print "on_button1_clicked called with self.%s" % widget.get_name()
    #-- MainWindow.on_button1_clicked }

    #-- MainWindow.on_entry1_activate {
    def on_entry1_activate(self, widget, *args):
        print "on_entry1_activate called with self.%s" % widget.get_name()
    #-- MainWindow.on_entry1_activate }

    #-- MainWindow.on_hscale1_value_changed {
    def on_hscale1_value_changed(self, widget, *args):
        print "on_hscale1_value_changed called with self.%s" % widget.get_name()
    #-- MainWindow.on_hscale1_value_changed }


class FileDialog(SimpleGladeApp):

    def __init__(self, path="sample.glade",
                 root="file_dialog",
                 domain=app_name, **kwargs):
        path = os.path.join(glade_dir, path)
        SimpleGladeApp.__init__(self, path, root, domain, **kwargs)

    #-- FileDialog.new {
    def new(self):
        print "A new %s has been created" % self.__class__.__name__
    #-- FileDialog.new }

    #-- FileDialog custom methods {
    #   Write your own methods here
    #-- FileDialog custom methods }

    #-- FileDialog.on_file_dialog_response {
    def on_file_dialog_response(self, widget, *args):
        print "on_file_dialog_response called with self.%s" % widget.get_name()
    #-- FileDialog.on_file_dialog_response }


#-- main {

def main():
    gnome.program_init("sample", "0.0.1")
    main_window = MainWindow()
    file_dialog = FileDialog()

    main_window.run()

if __name__ == "__main__":
    main()

#-- main }


Future enhancements
-------------------

Future versions of tepache will support both glade and gazpacho.
A plugin for gazpacho is being planned.