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.3.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2a96601b04d4266b3c092bb5301f498f9ff9a0066d2e8cc036130cd840638da2 |
|
MD5 | cec297726c8280d0896df52ee63ae68b |
|
BLAKE2b-256 | ce511ddd39bc4c93602ca448eb1d3af7462e0ef56e7b3b722440d0029110890e |
Hashes for document_merge_service-6.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 232a4688eb1f158dedf839f81e73890f5f45b4ae526d49075b636e869d79e9dc |
|
MD5 | ed0e9fbd5bae2ebc8f267e7dc22beb47 |
|
BLAKE2b-256 | e05bbf9982df113d9353731326909f57737de5677f7a8192efac96b28288f6b5 |