Skip to main content

Templating and pdf generation for docx/pptx files

Project description

=========
Burocracy
=========

Burocracy is a library that allows you to use .docx templates as
templates using MailMerge fields and can save them as docx's or pdfs. It
can insert plain text, images, tables and (simple) HTML. See
`django-bureaucracy`_ for some mild django integration.

WIP: PPTX as templates.

Usage
=====

Example
-------

.. code-block::

from bureaucracy import DocxTemplate, HTML, Image, Table

doc = DocxTemplate('examples/sample.docx')

context = {
'table': Table(data=[['this is the first cell of the first row', 'this is the second cell of the first row'],
['the second row', 'etc'],
['etc', 'etc]],
headers=['header 1', 'header 2']),
'image': Image('pigeon.jpg')
'html': HTML(<p><strong>bold</strong>-notbold</p><ul><li>hop</li><li>la</li><li>kee</li></ul>")
'text': 'some text',
}

doc.render_and_save('generated.docx', context)
doc.render_and_save('generated.pdf', context, format='pdf')


Inserting mail merge fields
---------------------------

Bureaucracy expects the .docx-files passed to the ``DocxTemplate`` constructor
to contain MailMerge fields whose names correspond to the ones used
in the context dict. How this is done exactly depends on the version of
Office you have, but it seems that it's always a variation on
Insert > Field > Mail Merge > Mergefield and then entering the name:

.. figure:: docs/mailmerge_mac.png?raw=true
:alt: Mailmerge on Mac

What it looks like on Office Mac 2015


Installation
============

.. code-block:: bash

pip install burocracy


Note that although this will install the pypandoc dependency, that package
makes use of the pandoc executable whose installation sometimes fails.
To work around this, install pandoc on it's own with your favorite package
manager and make it available on the path.

For the pdf generation, bureaucracy needs the LibreOffice ``soffice`` executable
to be installed and on the path.


.. _django-bureacracy: https://bitbucket.org/maykinmedia/django-bureaucracy

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

burocracy-0.4.1.tar.gz (14.7 kB view details)

Uploaded Source

Built Distribution

burocracy-0.4.1-py3-none-any.whl (19.4 kB view details)

Uploaded Python 3

File details

Details for the file burocracy-0.4.1.tar.gz.

File metadata

  • Download URL: burocracy-0.4.1.tar.gz
  • Upload date:
  • Size: 14.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for burocracy-0.4.1.tar.gz
Algorithm Hash digest
SHA256 5c808b07789669747bf018cd754675f7041c1bbea298b126076935672edf7273
MD5 b969ea9d4ad9ad71c85bc5b03c920c4a
BLAKE2b-256 a23836f8d3826c9d77c6acf0684389e4c9f9cf34a150f6da840bb792ceedc67b

See more details on using hashes here.

File details

Details for the file burocracy-0.4.1-py3-none-any.whl.

File metadata

File hashes

Hashes for burocracy-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2dce04d3759ec2c169376878425a3d98ada3968a1182b6a46933900f83998cdc
MD5 bf78940d59e2586c61d2d5c3352fee5e
BLAKE2b-256 f5a2ad69da7a36e6f11d02d3f466660ef0b10d195a3a3db8b5705d0c25ca58bc

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