A simple plug-n-play LaTeX renderer for Django REST Framework.
REST Framework LaTeX can be downloaded from PyPI:
pip install rest-framework-latex
Currently the LaTeX plugin requires lualatex
- to install this on Ubuntu:
sudo aptitude install texlive-latex-extra texlive-xetex
This will probably take some time due to the size of LaTeX (around 1GB)
You can then configure the renderer in your settings or on each view:
REST_FRAMEWORK = { 'DEFAULT_RENDERER_CLASSES': [ 'rest_framework_latex.renderers.LatexRenderer', ] }
The LATEX_RESOURCES
directory contains the base template environment e.g. any images or static resources to include in your template. This must be set for the renderer to work:
LATEX_RESOURCES = '/home/user/path_to_resources'
This works just like TemplateHTMLRenderer
but by setting a latex_name
on your view:
from rest_framework import viewsets from rest_framework_latex import renderers class SomeViewSet(viewsets.ViewSet): """ """ renderer_classes = [ renderers.LatexRenderer, ] latex_name = 'directory/latexfile.tex'
To use the template tags, add rest_framework_latex
to your INSTALLED_APPS
:
INSTALLED_APPS = [ ... 'rest_framework_latex', ... ]
The TeX file used for rendering will be pushed through Django's templating system. This will cause some issues whereby you want to do something like:
\textt{{{ some_variable }}}
To get around this issue you will need to do something like the following:
\textt{% templatetag openbrace %}{{ some_variable }}{% templatetag closebrace %}Tag Tag/Filter Purpose
latex_safe
Filter Escape all user-entered content for LaTeX rules latex_resources
Tag Print the value of settings.LATEX_RESOURCES
The renderer works by creating a new temporary directory, and then copying over the LATEX_RESOURCES
directory into the new temporary directory.
Next it renders the TeX file into the temporary directory.
Then it runs lualatex over the TeX file, and this will produce the PDF file we read into memory.
Then we delete the temporary directory and return the PDF to the client.
The REST Framework LaTeX plugin is compatible with Django 1.11 and up and Django REST Framework 3.3 and up.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4