Merge Document Template Service
Project description
Document Merge Service
A document template merge service providing an API to manage templates and merge them with given data. It can also be used to convert Docx files to PDF.
Installation
Requirements
- docker
- docker-compose
After installing and configuring those, download docker-compose.yml and run the following command:
docker-compose up -d
You can now access the api at http://localhost:8000/api/v1/ which includes a browsable api.
Workaround LibreOffice lockup
The workaround has a setting called ISOLATE_UNOCONV
, it is only enabled in the
development environment. If ISOLATE_UNOCONV
is enabled the container needs
CAP_SYS_ADMIN
. See docker-compose.override.yml.
cap_add:
- CAP_SYS_ADMIN
security_opt:
- apparmor:unconfined
environment:
- ISOLATE_UNOCONV=true
Getting started
Uploading templates
Upload templates using the following:
curl --form template=@docx-template.docx --form name="Test Template" --form engine=docx-template http://localhost:8000/api/v1/template/
Merging a template
After uploading successfully, you can merge a template with the following call:
curl -H "Content-Type: application/json" --data '{"data": {"test": "Test Input"}}' http://localhost:8000/api/v1/template/test-template/merge/ > output.docx
Converting a template
To convert a standalone Docx file the following call can be used:
curl -X POST --form file=@my-test-file.docx --form target_format="pdf" http://localhost:8000/api/v1/convert > example.pdf
Further reading
- Configuration - Further configuration and how to do a production setup
- Usage - How to use the DMS and it's features
- Contributing - Look here to see how to start with your first contribution. Contributions are welcome!
License
Code released under the GPL-3.0-or-later license.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for document_merge_service-6.5.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7d0013d50a185325bd6c2631e9605247b1ae749c00992f8379cc6b2e5b1a578a |
|
MD5 | 9d5c77680787cc747344c16312ca375d |
|
BLAKE2b-256 | bf421e6408bf6939d18f6ecc97792a4b6afa50295d525efba7498c49f7f8ce45 |
Hashes for document_merge_service-6.5.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2730351d2f94efe45960f5c8176d47e21e542199ca690a27adb96aadf0e9ca83 |
|
MD5 | 40c53aed540d63bb644303c66216e203 |
|
BLAKE2b-256 | c97d969c34423f0185c7fba97cc52e1f03f23ace274ec23fad48438e2327eb8b |