Man Linux: Main Page and Category List

NAME

       pyreport - generate reports out of Python scripts

SYNOPSIS

       pyreport [OPTIONS]

DESCRIPTION

       Processes a Python script and pretty prints the results using LateX. If
       the script uses "show()"  commands  (from  scitools.easyviz)  they  are
       caught  by pyreport and the resulting graphs are inserted in the output
       pdf. Comments lines starting with "#!" are interpreted as rst lines and
       pretty printed accordingly in the pdf.

OPTIONS

       --version
              Show program’s version number and exit.

       -h, --help
              Show help message and exit.

       -o FILE, --outfile=FILE
              Write report to FILE.

       -x, --noexecute
              Do not run the code, just extract the literate comments.

       -n, --nocode
              Do not display the source code.

       -d, --double
              Compile to two columns per page (only for pdf or tex output).

       -t TYPE, --type=TYPE
              Output  to TYPE, TYPE can be ps, dvi, trac, eps, tex, html, rst,
              moin.

       -f TYPE, --figuretype=TYPE
              Output figure type TYPE  (TYPE can be of pdf, jpg, eps, png,  ps
              depending on report output type).

       -c CHAR, --commentchar=CHAR
              Literate comments start with "#CHAR".

       -l, --latexliterals
              Allow LaTeX literal comment lines starting with "#$".

       -e, --latexescapes
              Allow LaTeX math mode escape in code wih dollar signs.

       -p, --nopyreport
              Disallow  the  use  of  #pyreport lines in the processed file to
              specify options.

       -q, --quiet
              Don’t print status messages to stderr.

       -v, --verbose
              Print all the message, including tex messages.

       -s, --silent
              Suppress the display of warning and errors in the report.

       --noecho
              Turns off the echoing  of  the  output  of  the  script  on  the
              standard out.

       -a ARGS, --arguments=ARGS
              Pass the arguments "ARGS" to the script.

NOTES

       This  is  a modified version of Gael Varoquaux’s pyreport to be able to
       use scitools.easyviz to do the plotting. The original pyreport  can  be
       downloaded from http://gael-varoquaux.info/computers/pyreport/.

LICENSE

       pyreport is licensed under the BSD license.

AUTHOR

       pyreport was written by Gael Varoquaux <gael.varoquaux@normalesup.org>.
       This manual page was written by Johannes Ring <johannr@simula.no>.