Development

You can contribute to the project in various ways:

• Submitting bug reports and feature requests.

  Since the project is in very early stages, this part is not relevant yet.

  You can file tickets on the issue tracker to submit bug reports and feature requests. To do this, you have to log in to the site using an OpenID account. Just click on the OpenID Login link above and you will get more information.

• Writing documentation.

  Since the project is in very early stages, this part is not relevant yet.

  Documentation on the wiki has to be marked up using the ReStructuredText language. More information and links about this can be found on the WikiRestructuredText page. More extensive documentation will be written using Sphinx, which also uses RestructuredText for markup.

• Translating the user interface into another language.

  Since the project is in very early stages, this part is not relevant yet.

  The project uses the GNU gettext mechanism for translations. Translating to a language is done by editing a ".po" file.

• Writing code.

  If you are interested, you are welcome to contribute code to the project. Note that any code contributed to the project MUST be licensed as GPLv3.

Writing code

To work on the source code Humphrey, you need a Python (2.5) development environment. If you intend to work on wxHumphrey, you also have to install wxPython.

The source code is kept in a Mercurial repository. You can clone it by using the command:

hg clone http://www.tekir.org/hg/humphrey

The development is managed using buildout. Run the commands given below to set up the environment. This will download and install many dependencies, so it will take some time and you will need a reliable Internet connection:

python bootstrap.py
./bin/buildout

You can run the tests to see if the core package works:

./bin/tests

Running the following command should start the wxHumphrey frontend:

./bin/wxhumphrey