fdfgen项目技术文档

本文档将详细介绍如何安装、使用及API调用fdfgen项目，该项目是一个Python端口，用于生成FDF（Form Data Format）文件，进而用于填充PDF表单。

1. 安装指南

安装fdfgen非常简单，只需使用pip命令即可：

pip install fdfgen

确保您的Python环境已安装pip，并且网络连接正常，以便能够从Python包索引（PyPI）下载并安装fdfgen。

2. 项目使用说明

设计PDF表单

首先，您需要使用Acrobat设计一个PDF表单（form.pdf），并在Acrobat中标记表单字段，记录下每个字段的名称。

生成FDF文件

通过以下步骤生成一个FDF文件，该文件包含将用于填充PDF表单的数据：

1. 在您的Python脚本中导入fdfgen模块。
2. 创建一个包含字段名称和值的列表。
3. 使用forge_fdf函数生成FDF数据。
4. 将FDF数据写入到一个文件。

以下是一个示例脚本：

#!/usr/bin/env python
from fdfgen import forge_fdf

# 定义表单字段和对应的值
fields = [('name', '张三'), ('telephone', '123-4567-8901')]

# 生成FDF数据
fdf = forge_fdf("", fields, [], [], [])

# 将FDF数据写入文件
with open("data.fdf", "wb") as fdf_file:
    fdf_file.write(fdf)

填充并 Flatten PDF表单

使用pdftk命令将生成的FDF文件填充到PDF表单中，并输出一个 flatten（不可编辑）的PDF：

pdftk form.pdf fill_form data.fdf output output.pdf flatten

执行此命令后，一个填充好的PDF文件output.pdf将被创建。

3. 项目API使用文档

fdfgen提供的API非常简单，主要围绕forge_fdf函数。以下是该函数的基本用法：

from fdfgen import forge_fdf

# 定义表单字段和对应的值
fields = [('字段名', '值'), ('字段名2', '值2')]

# 生成FDF数据
fdf_data = forge_fdf("", fields, [], [], [])

forge_fdf函数接收以下参数：

• info: 一个字典，包含文档信息。
• fields: 一个列表，列表中的元素是元组，表示字段名和值。
• fonts: 一个列表，定义字体信息（可选）。
• annotations: 一个列表，定义注释信息（可选）。

4. 项目安装方式

本项目可以通过以下两种方式进行安装：

• pip安装：如上所述，使用pip install fdfgen命令直接安装。
• 源码安装：从GitHub克隆项目代码，然后在项目目录下运行python setup.py install。

请确保在安装前已安装Python和pip，且pip版本是最新的。