= Welcome on the relatorio homepage =

Relatorio is an [http://www.openhex.com/ OpenHex] and [http://www.b2ck.com/ B2CK] project to easily create reports in a variety of formats (openoffice text, PDF, XHTML) from python objects.

On the technical side we are using different plugins to provide the same interface whether you want to create openoffice documents, charts or PDFs. The design of those plugins is inspired (and in fact makes use of) [http://genshi.edgewall.org/wiki/Documentation/templates.html Genshi templates]. For that reason, you will be able to find relevant help in the [http://genshi.edgewall.org/wiki/Documentation/ Genshi documentation].

A [QuickExample quick example] will show you how to get started. A more [IndepthIntroduction comprehensive introduction] will teach you how to use some of the more advanced features.

== Getting relatorio ==

Relatorio is opensource. The code is available in our mercurial repository. You can check it out with the following command:
{{{
hg clone http://hg.openhex.org/relatorio
}}}

An egg of relatorio is available on the [http://pypi.python.org/pypi/relatorio python package index]. Thus you should be able to install relatorio with easy-install with the following command (executed as root)
{{{
easy_install relatorio
}}}

== Getting help ==

A mailing list for relatorio is available at [http://mailman-mail5.webfaction.com/listinfo/relatorio].