reportlab/README
author rgbecker
Wed, 25 Oct 2000 08:57:46 +0000
changeset 494 54257447cfe9
parent 404 2b1bac113dfb
child 790 4960f2a12eab
permissions -rw-r--r--
Changed to indirect copyright

#copyright ReportLab Inc. 2000
#see license.txt for license details
#history http://cvs.sourceforge.net/cgi-bin/cvsweb.cgi/reportlab/README?cvsroot=reportlab
#$Header: /tmp/reportlab/reportlab/README,v 1.2 2000/10/25 08:57:44 rgbecker Exp $

Release 1.0
===========
This is release 1.0 or the ReportLab toolkit. It includes usable if
rough documentation as PDF documents and has a solid layout API
in reportlab.platypus (which if not frozen is certainly not totally
fluid).

Installation
============
Either unpack reportlab.zip or reportlab.tgz to some directory say
d:\ReportLab. If you can, ensure that the  line terminator style is
correct for your OS (man zip programs have a text mode option eg -a).

Create a .pth file, say reportlab.pth in your Python
home directory.  It should have one line:
d:/ReportLab.

Alternatively unpack the archive into a directory which is already on your
python path.

Then reportlab.pdfbase, reportlab.pdfgen and reportlab.platypus are
available packages.


Existing PDFGEN Code
=============
Modifying existing code to work with the package structure:

import pdfmetrics   ->  from reportlab.pdfbase import pdfmetrics
import pdfutils     ->  from reportlab.pdfbase import pdfutils
import pdfdoc       ->  from reportlab.pdfbase import pdfdoc

import pdfgeom      ->  from reportlab.pdfgen import pdfgeom

import pdfgen       ->  from reportlab.pdfgen import canvas
                    ->  from reportlab.pdfgen import pathobject
                    ->  from reportlab.pdfgen import textobject
                        then pdfgen.Canvas   -> canvas.Canvas
                        pdfgen.PDFPathObject -> pathobject.PDFPathObject
                        pdfgen.PDFTextObject -> textobject.PDFTextObject

import platypus     ->  from report.platypus import Flowable, Table

Testing
=======
You can run all python scripts in directories named test or tests.
At present there are tests in reportlab/pdfgen/test, reportlab/platypus/test
and reportlab/demos/tests.

The scripts in other subdirectories of demos are fairly useful.

Other executable scripts are
	./pdfbase/pdfdoc.py
	./pdfgen/canvas.py
	./platypus/tables.py