Skip to main content

PyLaTeX is a Python library for creating LaTeX files. The goal of this library is being an easy, but extensible interface between Python and LaTeX.

Features

The library contains some basic features I have had the need for so far. Currently those are:

  • Document generation and compilation

  • Section, table, math and package classes

  • A matrix class that can compile NumPy ndarrays and matrices to LaTeX

  • An escape function

  • Bold and italic functions

  • Every class has a dump method, which writes the output to a filepointer

Everything else you want you can still add to the document by adding LaTeX formatted strings instead of classes or regular strings.

Dependencies

  • Python 3.3 (Python 3.x might work as well)

  • pdflatex (only if you want to compile the tex file)

  • NumPy (only if you want to convert it’s matrixes)

Installation

pip install pylatex

Example

import numpy as np

from pylatex import Document, Section, Subsection, Table, Math
from pylatex.numpy import Matrix
from pylatex.utils import italic

doc = Document()
section = Section('Yaay the first section, it can even be ' + italic('italic'))

section.append('Some regular text')

math = Subsection('Math', data=[Math(data=['2*3', '=', 6])])

section.append(math)
table = Table('rc|cl')
table.add_hline()
table.add_row((1, 2, 3, 4))
table.add_hline(1, 2)
table.add_empty_row()
table.add_row((4, 5, 6, 7))

table = Subsection('Table of something', data=[table])

section.append(table)

a = np.array([[100, 10, 20]]).T
M = np.matrix([[2, 3, 4],
               [0, 0, 1],
               [0, 0, 2]])

math = Math(data=[Matrix(M), Matrix(a), '=', Matrix(M*a)])
print(math.dumps())
equation = Subsection('Matrix equation', data=[math])
print(equation.dumps())

section.append(equation)

doc.append(section)

doc.generate_pdf()

This code will generate this:

https://raw.github.com/JelteF/PyLaTeX/master/docs/static/screenshot.png

Future development

I will keep adding functionality I need to this library, an interface for graphics and math will probably be added in a future version.

If you add a feature yourself, or fix a bug, please send a pull request.

You can submit issues, but it will not be my priority to fix them. My job and education are a bit higher on the priority list.

Support

This library is being developed for Python 3.3. It currently doesn’t work for Python 2.7, but it’s mostly syntax and import changes that break it for 2.7. It is also only tested on Linux, so it might not work on any different platforms.

I have no intention of testing on any different platforms or with different Python versions. I also don’t have the intention to write fixes for platform or environment specific bugs, but pull requests that fix those are always welcome.

Download files

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

Source Distribution

PyLaTeX-0.3.1.1.tar.gz (5.3 kB view details)

Uploaded Source

File details

Details for the file PyLaTeX-0.3.1.1.tar.gz.

File metadata

  • Download URL: PyLaTeX-0.3.1.1.tar.gz
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for PyLaTeX-0.3.1.1.tar.gz
Algorithm Hash digest
SHA256 b48de668aacac276c5fbac9ceffc2d80b6ae2839013adec35b0c68a04b64d371
MD5 dccf6ef45b9cc3867b97aaf6fe5d2466
BLAKE2b-256 c8f6c420486fde58934e84d1d53ce464dc7ac8d195045666577de46d9e283eeb

See more details on using hashes here.

Supported by

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