# indexdoc-batch-generator
**Repository Path**: indexdoc/indexdoc-batch-generator
## Basic Information
- **Project Name**: indexdoc-batch-generator
- **Description**: 批量文档助手是一款高效便捷的文档批量生成工具，支持上传Excel文件与Word文件，可通过Excel文件定义最终生成文档的文件名规则，以及Word模板中需替换的相关字段；在Word模板中，只需将待替换内容以“{列名}”（列名为Excel文件中的对应列名）的形式标注，完成设置后点击生成按钮，即可快速批量生成符合需求的文档，大幅节省手动编辑、替换文档的时间成本，提升文档生成效率。
- **Primary Language**: Python
- **License**: MIT
- **Default Branch**: main
- **Homepage**: https://www.indexdoc.com/
- **GVP Project**: No
## Statistics
- **Stars**: 2
- **Forks**: 0
- **Created**: 2026-02-13
- **Last Updated**: 2026-02-24
## Categories & Tags
**Categories**: Uncategorized
**Tags**: 批量文档生成, 简单模板标注
## README
---
# Batch Document Assistant
Batch Document Assistant is an efficient document batch generation tool that supports uploading Excel and Word files. You can define the naming rules for the final generated documents via Excel, as well as the fields to be replaced in the Word template. In the Word template, simply mark the content to be replaced in the format of `{column name}` (where the column name corresponds to the column name in the Excel file). After completing the settings, click the generate button to quickly batch generate documents that meet your needs—greatly reducing the time cost of manual editing and replacement, and improving document generation efficiency.
[](https://www.python.org/) [](https://github.com/indexdoc/indexdoc-batch-generator.git) [](https://opensource.org/licenses/MIT)
## ✨ Core Features
- 🚀 **Batch Document Generation**: Based on Excel data and Word templates, one-click batch generation of custom documents with support for precise replacement of multiple fields
- 📋 **Flexible Naming Rules**: Define the filenames of the final generated documents via Excel columns, supporting naming methods such as combined column names and fixed text
- 📝 **Simple Template Annotation**: Word templates only need to mark content to be replaced with `{column name}`—no complex syntax required, easy to get started
- 📱 **Lightweight Design**: Pure Python implementation with no complex environment dependencies, supporting multi-system operation (Windows/macOS/Linux)
- 🔧 **Fault Tolerance Mechanism**: Built-in data validation and file format verification, supporting exception prompts and log output to avoid generation failures
- 🛠️ **Custom Extension**: Open core replacement logic, supporting secondary development (e.g., adding new file formats, custom replacement rules)
## 🚀 Quick Start
### Environment Preparation
- Python 3.10+, Tornado 6.0+, ClickHouse 22.0+
- Browsers: Chrome, Firefox, Edge, and other mainstream browsers.
```bash
https://gitee.com/indexdoc/indexdoc-batch-generator.git
```
```bash
# Install dependencies quickly
pip install -r requirements.txt
# Use Alibaba Cloud PyPI mirror (faster installation)
pip install -r requirements.txt -i https://mirrors.aliyun.com/pypi/simple/
```
### Database File Directory
```bash
sql/create_ck_table.sql
```
### Start the Service
```bash
cd src # Replace with the folder path where server.py is actually located
python.exe server.py
```
**Access Address**
Local access: `http://127.0.0.1:50003/public/batchDoc.html`
## 📝 Usage Example
Click the right area to upload the corresponding Excel/Word files. Click "Download Sample" to download the corresponding sample files.
After clicking "Generate All", Word files will be batch generated according to the content in the Excel file.
The column names starting from the second column in the Excel file correspond to the content in `{}` in the Word file. After clicking "Generate All", the content of each row will be filled into the Word document according to the column names.
### Sample Files
#### Example of Generated Files:
### Frequently Asked Questions
1. **Placeholders not replaced after document generation**: Check if the Excel column names are exactly the same (including case) as the placeholder column names in the Word template;
2. **Generation failure prompt**: Check if the Excel file contains a "Filename" column, or if the filename contains special characters;
3. **Partial documents fail to generate**: Check if the data in the corresponding row is complete, or if the Word template is corrupted
## 📞 Contact Information
- Author: Hangzhou Zhiyu Shu Information Technology Co., Ltd.
- Email: indexdoc@qq.com
- Official Website: https://www.indexdoc.com/