Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mypebble/rest-framework-latex
A LaTeX renderer for Django REST Framework
https://github.com/mypebble/rest-framework-latex
django django-rest-framework latex latex-renderer pdf rest rest-framework tex
Last synced: about 1 month ago
JSON representation
A LaTeX renderer for Django REST Framework
- Host: GitHub
- URL: https://github.com/mypebble/rest-framework-latex
- Owner: mypebble
- License: mit
- Created: 2016-05-17T08:35:05.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-06-10T18:02:08.000Z (over 3 years ago)
- Last Synced: 2024-06-29T12:23:04.024Z (3 months ago)
- Topics: django, django-rest-framework, latex, latex-renderer, pdf, rest, rest-framework, tex
- Language: Python
- Size: 41 KB
- Stars: 33
- Watchers: 5
- Forks: 7
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-django-rest-framework - rest-framework-latex
- starred-awesome - rest-framework-latex - A LaTeX renderer for Django REST Framework (Python)
README
# REST Framework LaTeX Plugin
[](https://circleci.com/gh/mypebble/rest-framework-latex)
[](https://badge.fury.io/py/rest-framework-latex)
[](http://drf-latex.readthedocs.io/en/latest/?badge=latest)
A simple plug-n-play LaTeX renderer for Django REST Framework.
[Documentation](http://drf-latex.readthedocs.io/en/latest/)
## Installing
REST Framework LaTeX can be downloaded from PyPI:
```bash
pip install rest-framework-latex
```
## Dependencies
Currently the LaTeX plugin requires `lualatex` - to install this on Ubuntu:
```bash
sudo aptitude install texlive-latex-extra texlive-xetex
```
This will probably take some time due to the size of LaTeX (around 1GB)
## Using the Renderer
You can then configure the renderer in your settings or on each view:
```python
REST_FRAMEWORK = {
'DEFAULT_RENDERER_CLASSES': [
'rest_framework_latex.renderers.LatexRenderer',
]
}
```
### `LATEX_RESOURCES` Setting
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:
```python
LATEX_RESOURCES = '/home/user/path_to_resources'
```
This works just like `TemplateHTMLRenderer` but by setting a `latex_name` on
your view:
```python
from rest_framework import viewsets
from rest_framework_latex import renderers
class SomeViewSet(viewsets.ViewSet):
"""
"""
renderer_classes = [
renderers.LatexRenderer,
]
latex_name = 'directory/latexfile.tex'
```
### Latex Templates
To use the template tags, add `rest_framework_latex` to your `INSTALLED_APPS`:
```python
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:
```latex
\textt{{{ some_variable }}}
```
To get around this issue you will need to do something like the following:
```latex
\textt{% templatetag openbrace %}{{ some_variable }}{% templatetag closebrace %}
```
#### Included Tags
| 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` |
## How it works
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.
## Django Compatibility
The REST Framework LaTeX plugin is compatible with Django 1.11 and up and
Django REST Framework 3.3 and up.