Skip to content

pytask-dev/latex-dependency-scanner

Repository files navigation

PyPI - Python Version image image PyPI - License image image pre-commit.ci status image

Features

latex-dependency-scanner is a package to detect all required files to compile a LaTeX document.

Installation

latex-dependency-scanner is available on PyPI and Anaconda.org. Install it with

$ pip install latex-dependency-scanner

# or

$ conda install -c conda-forge latex-dependency-scanner

Usage

The package contains two functions.

Scan

scan() accepts a path-like object or a list of path-like objects which point to .tex documents. The return is a collection of paths related to this document.

import latex_dependency_scanner as lds


paths = lds.scan("document.tex")

For dependencies which cannot be found and which have no file extension (like graphics in \includegraphics), all possible candidates are returned.

PDF

compile_pdf() allows to conveniently generate PDFs with Python. The function is mainly used for validating test cases.

import latex_dependency_scanner as lds


lds.compile_pdf("document.tex", "document.pdf")

Changes

Consult the release notes to find out about what is new.