Skip to main content

Simple LaTeX log file parsing library.

Project description

TexOutParse

Simple output/log file parsing library for LaTeX builds.

LaTeX log files are notoriously unstructured and there is a wide variance in the style and content of messages. Messages can be roughly characterised as an error, an warning, a bad box, or info. Packages and classes can also generate messages and, while there are template macros for producing such messages, no structure is enforced on the messages.

Many LaTeX editors provide a log file parser that runs automatically on building the document. A summary of the errors, warnings, and bad boxes is usually displayed to the user. There does not seem to be any library or tool for parsing log files separate from these editors.

Installalation

The library can be installed via Pip

pip install texoutparse

Usage

The main class provided by this library is LaTexLogParser, which is used to parse the log file and collect the statistics.

from texoutparse import LatexLogParser

parser = LatexLogParser()
with open('sample.log') as f:
    parser.process(f)

The parser object contains lists of errors, warnings, and bad boxes, each described by an LogFileMessage object. Both objects provide a __str__ method that prints a summary of the error in the case of LatexLogParser and the raw lines in the case of LogFileMessage.

>>> print(parser)
Errors: 1, Warnings: 1, Badboxes:1

>>> print(parser.errors[0])
! Undefined control sequence.
l.6 \dtae
{December 2004}

Contributing

  1. Fork it. (https://github.com/inakleinbottle/fork)
  2. Create a feature branch. (git checkout -b feature/name)
  3. Commit your changes. (git commit -m 'add some feature')
  4. Push the branch to Github. (git push origin feature/name)
  5. Create a pull request.

Meta

Sam Morley - inakleinbottle.com - admin@inakleinbottle.com

Distributed under the MIT license. See LICENSE for more information.

Release History

  • 1.0. Initial release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

texoutparse-1.0.0.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

texoutparse-1.0.0-py2.py3-none-any.whl (5.2 kB view details)

Uploaded Python 2Python 3

File details

Details for the file texoutparse-1.0.0.tar.gz.

File metadata

  • Download URL: texoutparse-1.0.0.tar.gz
  • Upload date:
  • Size: 4.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.7

File hashes

Hashes for texoutparse-1.0.0.tar.gz
Algorithm Hash digest
SHA256 79bee7f25d14070b4d50ddad53f550d5ce1530a1cc083f98a7119226cf6e3852
MD5 2ea6559140c37a3ebe747b850d3a7455
BLAKE2b-256 7c9e6be9f1d54b7124ff43c5565d5cee88511c73a3e59f958f3794dc1b9aca21

See more details on using hashes here.

File details

Details for the file texoutparse-1.0.0-py2.py3-none-any.whl.

File metadata

  • Download URL: texoutparse-1.0.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 5.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.7

File hashes

Hashes for texoutparse-1.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 094488352f53b3a17169127fe73e62d8591968da65c601507de17f8389e9573c
MD5 6fd9371c25d801f9657d8ca63508c6b1
BLAKE2b-256 777bca530b66acf5a88e3149965d9c2a87012f744cb8a4b19091c7d0aaa26ddd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page