scielo.packtools

Python library and command-line utilities to handle SciELO PS XML files that runs on python > 3.9.

Build status

Installation

packtools depends on lxml.

Pip + GitHub (recommended) — check the latest version at GitHub releases and replace the version in the URL accordingly:

$ pip install https://github.com/scieloorg/packtools/archive/refs/tags/4.16.0.zip

Pip + git (development version):

$ pip install git+https://github.com/scieloorg/packtools.git

Source-code:

$ git clone https://github.com/scieloorg/packtools.git
$ cd packtools
$ python setup.py install

Installation as a web application, where a graphical interface for stylechecker and an HTML previewer is provided (replace the version in the URL with the latest from GitHub releases):

$ pip install "packtools[webapp] @ https://github.com/scieloorg/packtools/archive/refs/tags/4.16.0.zip"

or

pip install -r requirements.txt && pip install -r optional-requirements.txt

Formula rendering in generated PDFs

Articles with math formulas (<disp-formula>) need the libreoffice-math system package for the formulas to render in the final PDF:

$ sudo apt install libreoffice-math

Without it, formulas still convert to OMML in the DOCX, but LibreOffice fails to render them when producing the PDF.

Tests

To run tests execute:

python setup.py test

To run a specific module of tests, type:

python setup.py test -s tests.test_htmlgenerator

Run tests with tox:

tox

Command line execute

htmlgenerator example.xml --loglevel=error --nochecks --nonetwork

It will generate the result in the same path of the .xml file.

Running the web application

Configuring the application:

environment variable	default value
APP_SETTINGS	packtools.webapp.config.default.ProductionConfig

$ export APP_SETTINGS=packtools.webapp.config.default.ProductionConfig
$ export FLASK_APP=packtools.webapp.app.py
$ flask run

Documentation

http://packtools.readthedocs.org/ (we need help!)

Use license

Copyright 2013 SciELO scielo-dev@googlegroups.com. Licensed under the terms of the BSD license. Please see LICENSE in the source code for more information.

https://github.com/scieloorg/packtools/blob/master/LICENSE

Changelog

https://github.com/scieloorg/packtools/blob/master/HISTORY.md