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.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 78feae0a2af871b03f9521f0725ec4b9463d37df812537d753cdae0db2622139 |
|
MD5 | f5c7860c869b86bd696653f5bd9ef092 |
|
BLAKE2b-256 | b4dfaa07629ff1f8202872940cfbe99d28987a3d2e6aed8894a66510919073bd |
Hashes for document_merge_service-6.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dad664da62356877e35ecb5c942d891ff03e34aecd5b12710298260ccf6e6a6f |
|
MD5 | abc19a03c89bacc73578c405a6529210 |
|
BLAKE2b-256 | b28113f86d97ff4a1c3df7d4984bd60722da256b928315c02d3f50837d313978 |