First step : Install it
PyF is available under the MIT license. It is made of several layers:
- low-level (only needed for programming in your own software),
- mid-level (pyf.componentized: needed to run xml files of pyf tubes and use its plugins),
- and high-level (with webservice, scheduler and visual tube designer).
Following instruction are mainly for high-level libraries (installing others as dependencies).
PyF releases are available on the Python Package Index, to install them just issue the following commands (creating a virtualenv first is really recommended).
The "-UZ" switch used on the easy_install command is to force the update of existing packages, and unpacking of libraries, which is often really needed if you run several apps at once (and improves performance).
(optionnal) Create a virtual env :
$ easy_install -UZ virtualenv # if you do not have it
$ virtualenv --no-site-packages pyfenv
Activate it, so the python command is the one from the virtual env :
$ cd pyfenv
$ source bin/activate
Or in windows :
$ cd pyfenv
You can grab everything in one simple step :
$ easy_install -UZ pyf[fullstack] # replace "fullstack" with "minimal" to get only low level or "component" to get everything beside the web service
Or, manually install pyf high level lib :
$ easy_install -UZ pyf.services
Then, still manually install whatever plugins you need :
$ easy_install -UZ pyf.components.consumers.csvwriter # CSV writer
$ easy_install -UZ pyf.components.consumers.rmlpdfwriter # PDF Writer based on pyjon.reports, z3c.rml and genshi
$ easy_install -UZ pyf.components.consumers.xhtmlpdfwriter # XHTML PDF Writer base on genshi and pisa
$ easy_install -UZ pyf.components.consumers.xlsxwriter # simple XLSX files writer
$ easy_install -UZ pyf.components.consumers.xmlwriter # Simple XML file writer (based on genshi)
$ easy_install -UZ pyf.components.producers.webextractor # Simple web extractor, to extract raw data from websites as python objects
After you installed it
See the configuration guide for further instructions.