A FastAPI based project to generate DOCX and PDF documents from a DOCX template, JSON data and images.
The project uses easy-template-x to fill the DOCX template: all tags and filters provided by this project are available.
- Example
- System Requirements
- Installation
- Running Locally
- Swagger Documentation
- Development Environment
- Testing
- Sample Commands
- Docker
- References
Python 3, NodeJS and LibreOffice must be installed globally.
The Docker image will install all requirements when built.
Create and activate a virtual environment
python3 -m venv .venv
source .venv/bin/activate
Install requirements
pip install -r requirements.txt
Then setup the Node package with
cd app/scripts/
npm install
uvicorn app.main:app --reload
Install and run locally then visit http://localhost:8000/docs.
For development and testing, install additional requirements
pip install -r requirements.dev.txt
Install the development dependencies, then run pytest from the project root.
Use the sample files in app/tests/sample_data.
cd app/tests/sample_data
curl -X POST http://localhost:8000/api/v1/render/to_docx \
-F 'json_data={"hello": "Bonjour", "world": "à tous"}' \
-F 'docx_file=@./1_hello_world.docx' > result_1.docx
curl -X POST http://localhost:8000/api/v1/render/to_pdf \
-F 'json_data={
"sample_document_header": "FastDocxAPI sample document",
"title": "FastDocxAPI - A Full Sample",
"heading_1": "Style",
"paragraph_1": "All Libreoffice features are available. Style is not modified by templating, and images can be included too!",
"heading_2": "Lorem Ipsum",
"paragraph_2": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
"table_first": [
{
"first_col": "Monday",
"second_col": "Tuesday",
"third_col": "Other..."
},
{
"first_col": "Hello",
"second_col": "World",
"third_col": "Good Bye"
},
{
"first_col": "Alice",
"second_col": "Bob",
"third_col": "Charlie"
}
],
"other_table": [
{
"value_1": "Something",
"value_2": "to"
},
{
"value_1": "test",
"value_2": "here."
}
],
"simplelist": [
{"item": "one"},
{"item": "two"},
{"item": "and more"}
],
"otherlist": [
{"level_main": "Top", "sub_levels": [{"content": "a"}, {"content": "b"}]},
{"level_main": "Not top", "sub_levels": [{"content": "fgh"}, {"content": "ijk"}]}
]
}' \
-F 'docx_file=@./2_all_features.docx' \
-F 'image_files=@./image.jpg' \
-F 'image_files=@./logo.png' > result_2.pdf
Build the image: this can take several minutes to install LibreOffice and NodeJS.
docker build -t fastdocxapi
Run with docker run -p 8000:80 fastdocxapi.
The latest build can be found on Docker Hub.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent