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

templateddocs-0.3.4.tar.gz (48.4 kB view details)

Uploaded Source

File details

Details for the file templateddocs-0.3.4.tar.gz.

File metadata

  • Download URL: templateddocs-0.3.4.tar.gz
  • Upload date:
  • Size: 48.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.7

File hashes

Hashes for templateddocs-0.3.4.tar.gz
Algorithm Hash digest
SHA256 15d5ea7e397a0acd08a59a022e9656c4aeb64135ca51d2afaa8c6261c67ed20b
MD5 6980e8eeb761d49933f15553a35fe742
BLAKE2b-256 ab2497c989d71465cbf2d3dda953e60e5f561c4b8bb5c0303ff672aab83f74bc

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