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.
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
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.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | aa02e82d62daa679e927926f1b79661951064aad9887bb17f18f6ccd40db60f7 |
|
MD5 | c67ee0f459913d27f4738fb83bdcd9d0 |
|
BLAKE2b-256 | c0cedf01e13feec4abe613b8087edb03e104884539d69bbf99b6cac2967de7ab |
Hashes for document_merge_service-6.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1236305bcbecc8fd0b63e1928f7b4f4d3dd9495655a05f80b8863bcdbb0dd311 |
|
MD5 | 42af9669457907450cba4609463e4b48 |
|
BLAKE2b-256 | b191c159cdd975dc650395d8eb2ddb98f24aded43e9c4fbd11d3f8c9da295e65 |