# Installation

## Dependencies

The required dependencies are:

> - Python 2.4.3
> - GTK+ 2.10.4
> - PyGTK 2.10.1

or newer.

## Installation

You can install gtkmvc from source files, with the provided standard `setup.py` based on `distutils`:

    $> python setup.py install

Alternatively, Windows users may use the binary installer, and GNU/Linux users may check if their distribution offers packages for an easy installation. For example under Ubuntu Linux 10.10 Maverick Meerkat:

    $> apt-cache search gtkmvc
    python-gtkmvc - model-view-controller (MVC) implementation for pygtk
    python-gtkmvc-doc - pygtkmvc documentation, tutorial and examples

However, make sure that you are using the latest available version.

## Use without installing

gtkmvc is designed to work also without being installed, so it is possible to keep it locally. A typical directory tree of an application based on gtkmvc may be:

    top-level
       |
       |-------- main.py, setup.py, ...
       |
       |-------- resources
       |             |------ bin
       |             |------ glade
       |             |------ images
       |             |------ ...
       |             +------ external         <---- sys.path contains this
       |                        |--- ...
       |                        +--- gtkmvc   <---- PUT IT HERE!
       |-------- src
       |          |------ models
       |          |------ views
       |          |------ controllers
       |          +------ ...
       |
       +-------- ...

By prepending external to `sys.path`, gtkmvc will be found as if it was installed regularly.

Section progen: A Project Generator presents a little utility to build a project based on gtkmvc from scratch. progen generates a structure similar to this, if you decide to distribute gtkmvc along with your application.

## Distribution of your application

If you want, you can distribute gtkmvc along with your application, for example as depicted above. This helps to minimize the dependencies of your application.

## License and Copyright

gtkmvc is Free Software distributed under the GNU LESSER GENERAL PUBLIC LICENSE (LGPL) version 2 or later at your choice.

You can distribute your application in any form (even binaries only) and for any purpose (even commercial). However if you have modified any file of gtkmvc, you will have to distribute the source files of your modified version of gtkmvc. For any detail refer to the LGPL License Terms.

Copyright (C) 2010 by Roberto Cavada <roboogle AT gmail.com>.