JelteF / PyLaTeX

A Python library for creating LaTeX files
https://jeltef.github.io/PyLaTeX/
MIT License
2.24k stars 287 forks source link

PyLaTeX |Actions| |License| |PyPi| |Latest Docs|

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

Installation

Simply install using pip::

pip install pylatex

And then install a relevant LaTeX processor and other dependencies. Examples:

Ubuntu


    sudo apt-get install texlive-pictures texlive-science \
    texlive-latex-extra latexmk

Documentation
-------------

- For more details on how to use the library take a look at `the documentation
  <https://jeltef.github.io/PyLaTeX/current/>`__.

Contributing
------------

Read the `How to
contribute <https://jeltef.github.io/PyLaTeX/latest/contributing.html>`__
page for tips and rules when you want to contribute.

Examples
--------

The documentation contains a lot of examples that show the
functionality. To give an impression of what can be generated see this
picture:

.. figure:: https://raw.github.com/JelteF/PyLaTeX/master/docs/source/_static/screenshot.png
   :alt: Generated PDF by PyLaTeX

Copyright and License
---------------------

Copyright 2014 Jelte Fennema, under `the MIT
license <https://github.com/JelteF/PyLaTeX/blob/master/LICENSE>`__

.. |Actions| image:: https://github.com/JelteF/PyLaTeX/actions/workflows/ci.yml/badge.svg
   :target: https://github.com/JelteF/PyLaTeX/actions/workflows/ci.yml

.. |License| image:: https://img.shields.io/github/license/jeltef/pylatex.svg   
   :target: https://github.com/JelteF/PyLaTeX/blob/master/LICENSE

.. |PyPi| image:: https://img.shields.io/pypi/v/pylatex.svg
   :target: https://pypi.python.org/pypi/PyLaTeX

.. |Latest Docs| image:: https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat
   :target: https://jeltef.github.io/PyLaTeX/latest/