Rename TinyERP to OpenERP in scripts.
[odoo/odoo.git] / doc / README.pychart
1 * What is this package?
2
3 PyChart is a Python library for creating professional quality PS, PDF,
4 PNG, or SVG charts.  It supports line plots, bar plots, range-fill
5 plots, and pie charts.  Because it is based on Python, you can make
6 the full use of Python's scripting power.
7
8 The PyChart home page is at 
9 http://www.hpl.hp.com/personal/Yasushi_Saito/pychart
10
11 * What you need
12
13 You need Python (http://www.python.org) version 2.2 or later (on
14 Debian GNU/Linux, you need, python-xml package as well). You also need
15 Ghostscript (http://www.cs.wisc.edu/~ghost/) to produce PNG
16 files. 
17
18         Pychart used to require Ghostscript during PS and PDF
19         generation to obtain font metric information, but that's no
20         longer the case.
21
22 * Platforms supported
23
24 In theory, PyChart works on any platform with Python.  In practice,
25 I've run PyChart on Linux and Win2000.
26
27 * Installation
28
29 Become a root and do:
30
31         # python setup.py install
32
33 Or, you can set PYTHONPATH environment variable before you start
34 Python. For example (in bash):
35
36 % PYTHONPATH=~/PyChart-1.33/pychart python mumbo.py
37
38 * Documentation
39
40 A detailed documentation is found in doc/pychart.
41
42 * Examples
43
44 All the *.py files in the demos/ directory can be run directly. For
45 example,
46
47     setenv PYTHONPATH ..
48     python linetest.py >foo.eps
49     gs foo.eps
50
51 or
52
53     setenv PYTHONPATH ..
54     setenv PYCHART_OPTIONS="format=pdf"
55     python linetest.py >foo.pdf
56     acroread foo.pdf
57
58 * About the author
59
60 Yasushi Saito (ysaito@hpl.hp.com), a full-time researcher and
61 part-time hacker. This program is created mainly to serve my personal
62 needs to write pretty charts for research papers. As such, it is
63 updated only when I'm writing a paper, which happens about once every
64 half year or so.
65
66 Anyway, if you have comments, requests, or (even better)
67 fixes/enhancements, feel free to email me.
68