Skip to content

JessicaTegner/PyTinyTeX

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

37 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PyTinyTeX

Build Status PyPI version Development Status Python version License

PyTinyTeX provides a thin wrapper for TinyTeX, A lightweight, cross-platform, portable, and easy-to-maintain LaTeX distribution based on TeX Live.

Installation

Installation through the normal means

§§§ pip install pytinytex §§§

Installing a version of TinyTeX

Each version of TinyTeX contains three variations:

  • TinyTeX-0.* contains the infraonly scheme of TeX Live, without any LaTeX packages.
  • TinyTeX-1.* contains about 90 LaTeX packages enough to compile common R Markdown documents (which was the original motivation of the TinyTeX project).
  • TinyTeX-2-* contains more LaTeX packages requested by the community. The list of packages may grow as time goes by, and the size of this variation will grow correspondingly.

By default the variation PyTinyTeX will install is variation 1, but this can be changed.

§§§ import pytinytex

pytinytex.download_tinytex(variation=0) §§§

Getting the TinyTeX path

After installing TinyTeX, you can get the path to the installed distribution with the following:

§§§ import pytinytex

pytinytex.get_tinytex_path()

/home/jessica/.pytinytex/

c:\Users\Jessica.pytinytex\

§§§

Integrating with pypandoc

PyTinyTeX can be used with PyPandoc, a Python wrapper for Pandoc. PyPandoc can be used to convert documents between different formats, including LaTeX to PDF. To use PyTinyTeX with pypandoc, when working with latex or pdf documents, you need to give pypandoc the path the pdflatex (included with variation 1 and above), like the ofllowing:

§§§ import pytinytex import pypandoc

make sure that pytinytex is installed

pytinytex.download_tinytex(variation=1)

get the path to the pdflatex executable

pdflatex_path = pytinytex.get_pdf_latex_engine()

convert a markdown file to a pdf

pypandoc.convert_file('input.md', 'pdf', outputfile='output.pdf', extra_args=['--pdf-engine', pdflatex_path]) §§§

TODO

  • Write docs, since this looks to be a bigger wrapper than PyPandoc
  • Wrap the tlmgr interface
  • Wrap the PDFLatex engine

Contributing

Contributions are welcome. When opening a PR, please keep the following guidelines in mind:

  1. Before implementing, please open an issue for discussion.
  2. Make sure you have tests for the new logic.
  3. Add yourself to contributors at README.md unless you are already there. In that case tweak your

Contributors

License

PyTinyTeX is available under MIT license. See LICENSE for more details. TinyTeX itself is available under the GPL-2 license.