Skip to main content

Generate PDF, MS Word and Excel documents from templates in Django.

Project description

https://badge.fury.io/py/templated-docs.svg https://img.shields.io/travis/kiawin/templated-docs.svg Documentation Status Dependencies

Generate templated documents within Django in any format supported by LibreOffice: texts, spreadsheets, presentations etc.

Requirements

  • Python 2.7 or 3.4+

  • Django >= 1.8

  • A recent LibreOffice version (>=4.3.0) supporting LibreOfficeKit API.

Example usage

Create a sample.odt document (make sure it’s in OpenDocument format) and put it in your Django templates folder. It should look something like this:

https://github.com/kiawin/templated-docs/raw/master/docs/document-template.png

Then write a view to generate documents from this template:

from templated_docs import fill_template
from templated_docs.http import FileResponse

def get_document(request):
    """
    A view to get a document filled with context variables.
    """
    context = {'user': request.user}  # Just an example

    filename = fill_template('sample.odt', context, output_format='pdf')
    visible_filename = 'greeting.pdf'

    return FileResponse(filename, visible_filename)

Navigate to the url your view is connected to, and you’ll see a rendered and converted document:

https://github.com/kiawin/templated-docs/raw/master/docs/generated-document.png

For more examples, see the examples/ subfolder in the repository. More detailed documentation is available on https://templated-docs.readthedocs.io.

Credits

Templated-docs was written by Alex Morozov.

As the repository is left idle for 2 years, Sian Lerk Lau has forked and resume the task of updating the module.

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Project details


Download files

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

Source Distribution

jpt-templated-docs-0.4.0.tar.gz (48.1 kB view details)

Uploaded Source

Built Distribution

jpt_templated_docs-0.4.0-py2.py3-none-any.whl (19.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file jpt-templated-docs-0.4.0.tar.gz.

File metadata

  • Download URL: jpt-templated-docs-0.4.0.tar.gz
  • Upload date:
  • Size: 48.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.6

File hashes

Hashes for jpt-templated-docs-0.4.0.tar.gz
Algorithm Hash digest
SHA256 a5a3f052915237b545d5f98e5d6073654adca0f08264a8a057c31717015e7648
MD5 9c0903194e5b7b04ffb6e0094a30e2a1
BLAKE2b-256 8d2b993cc1946ee10ba1a3bf07ff7ab8e50ec5d9398ed749dc42bf47b1a3aa50

See more details on using hashes here.

File details

Details for the file jpt_templated_docs-0.4.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for jpt_templated_docs-0.4.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f9466715883ea3d4139caf425864d8458df6e748ad63a931b9f36758233ce11d
MD5 058de2cf0a12163cf5fe2ec12b67e3c5
BLAKE2b-256 287d2ce83793df511ffda33d453f808440d95e6caddfd90948c43c25a0460e3a

See more details on using hashes here.

Supported by

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