Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Python wrapper around pdflatex
Python TeX
branch: master
Failed to load latest commit information.
bin
pydflatex
test
.gitignore
LICENSE.md
README.md
requirements.txt
screenshot.png
setup.py

README.md

pydflatex: a simple LaTeX wrapper

pydflatex is a wrapper around pdflatex which produces a short, readable, coloured output. Specifically, pydflatex

  • runs pdflatex/xelatex blazingly fast using the -batchmode option
  • prints out a coloured, short summary of the warnings and errors
  • hides the temporary files in various ways
  • opens the pdf file if needed

Screenshot

Usage

pydflatex file.tex

Some useful options:

  • -x: run xelatex instead of pdflatex
  • -k: keep compiling on error
  • -o: open the pdf in a pdf viewer
  • -l: only parse existing log

A full list of options is available by running pydflatex --help.

Using as a Library

pydflatex is a collection of several independent modules to typeset the file, analyze its log, hiding the auxilliary files, etc. It is easy to write a simple python script that calls either one of those modules and does exactly what you want in your project.

For instance, to run a given file with xelatex you can call:

from pydflatex import Typesetter
t = Typesetter(options={'xetex'=True})
t.typeset(path_to_file)

In order to just print the summary of the log:

from pydflatex import LogProcessor
l = LogProcessor()
l.process_log(path_to_log_file)

Feel free to check out the other modules inside the pydflatex folder.

Requirements

  • Python v.2.6 (because of the new string formatting)
  • termstyle (optional but strongly advised): to display results in colour
Something went wrong with that request. Please try again.