Orgreport
=========

Description
-----------

Orgreport allows to output data formatted in the `Org-mode
<http://orgmode.org>`_ format. It can be used to generate reports which
may exported to any of the export format supported by Org-mode.

Prerequisite
------------

If you want to use the auto-export feature, you need a working Emacs and
Org-mode.

Example
-------

::

  # The main Org object
  org = Orgreport(title="Some nice experiment", path="reports", verbose=True, options="toc:1", html=True)
  
  # A paragraph
  org.para("Description")
  org.content("This is a funky way of testing if....")
  org.content("second line of the paragraph")
  org.end()
  
  # A table, which will be plotted with org-plot
  scores = org.table(titles = ["Alpha", "Score"], plot = "ind:1
  set:\"yrange [0:]\"")
  
  org.para("Let's go")
  # Some computation
  for x in range(10):
    y = random.random()
    scores.append((x, y))
    org.content(x + "" + y)
  org.end()
  
  # Format the table
  scores.output()
  
  # Finally close the Org object
  org.end()

Download
--------

Directly: http://www.lix.polytechnique.fr/~schwander/orgreport/orgreport-0.1.tar.gz

On PyPI: http://pypi.python.org/pypi/orgreport

Darcs repository: http://www.lix.polytechnique.fr/~schwander/darcs/orgreport/

Licence
-------

Orgreport is free software, released under the term of the BSD license.

Copyright 2010-2011 Olivier Schwander <schwander@lix.polytechnique.fr>

