-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3a1bfbf
commit a436c90
Showing
6 changed files
with
205 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,181 @@ | ||
| src/readme.md | ||
|
|
||
| > 注：当前项目为 Serverless Devs 应用，由于应用中会存在需要初始化才可运行的变量（例如应用部署地区、函数名等等），所以**不推荐**直接 Clone 本仓库到本地进行部署或直接复制 s.yaml 使用，**强烈推荐**通过 `s init ${模版名称}` 的方法或应用中心进行初始化，详情可参考[部署 & 体验](#部署--体验) 。 | ||
| # start-word2pdf-dipper 帮助文档 | ||
|
|
||
| <description> | ||
|
|
||
| 本案例是将 word 转 pdf 的逻辑封装成一个python函数，快速创建并部署到阿里云函数计算 FC。 | ||
|
|
||
| </description> | ||
|
|
||
| <codeUrl> | ||
|
|
||
|
|
||
|
|
||
| </codeUrl> | ||
| <preview> | ||
|
|
||
|
|
||
|
|
||
| </preview> | ||
|
|
||
|
|
||
| ## 前期准备 | ||
|
|
||
| 使用该项目，您需要有开通以下服务并拥有对应权限： | ||
|
|
||
| <service> | ||
|
|
||
|
|
||
|
|
||
| | 服务/业务 | 权限 | 相关文档 | | ||
| | --- | --- | --- | | ||
| | 函数计算 | AliyunFCFullAccess | [帮助文档](https://help.aliyun.com/product/2508973.html) [计费文档](https://help.aliyun.com/document_detail/2512928.html) | | ||
|
|
||
| </service> | ||
|
|
||
| <remark> | ||
|
|
||
|
|
||
|
|
||
| </remark> | ||
|
|
||
| <disclaimers> | ||
|
|
||
|
|
||
|
|
||
| </disclaimers> | ||
|
|
||
| ## 部署 & 体验 | ||
|
|
||
| <appcenter> | ||
|
|
||
| :fire: 通过 [Dipper 应用中心](https://devs.console.aliyun.com/applications/createtemplate=start-word2pdf-dipper) ，[](https://devs.console.aliyun.com/applications/createtemplate=start-word2pdf-dipper) 该应用。 | ||
|
|
||
| </appcenter> | ||
| <deploy> | ||
|
|
||
| </deploy> | ||
|
|
||
| ## 案例介绍 | ||
|
|
||
| <appdetail id="flushContent"> | ||
|
|
||
| 本案例是将 word 转 pdf 的逻辑封装成一个python函数，快速创建并部署到阿里云函数计算 FC。 | ||
|
|
||
| 运用了soffice，它是LibreOffice套件中的一个命令行工具，它允许用户启动LibreOffice的应用程序并处理文档 | ||
| 1. 文档处理：soffice可以用来打开、编辑、转换不同格式的文档文件，包括文字处理文档、电子表格、演示文稿等。 | ||
| 2. 格式转换：可以将文档从一个格式批量转换为另一个格式，例如将多个DOC文件转换为PDF。 | ||
| 3. 服务器模式：通过--headless选项，soffice可以在不启动图形用户界面的情况下运行，非常适合服务器和自动化脚本使用。 | ||
|
|
||
| 通过 Serverless 开发平台，您只需要几步，就可以体验 word 转 pdf，并享受 Serverless 架构带来的降本提效的技术红利。 | ||
|
|
||
| </appdetail> | ||
|
|
||
| ## 使用流程 | ||
|
|
||
| <usedetail id="flushContent"> | ||
|
|
||
| ### 查看部署的案例 | ||
|
|
||
| 1、部署成功后，从资源信息栏，找到对应函数资源，点击函数名称跳转到函数计算控制台，如： | ||
|  | ||
| 2、在代码页签，单击测试函数右侧的图标，从下拉列表中选择配置测试参数，输入如下示例测试参数，然后单击确定。 | ||
|
|
||
| ``` | ||
| { | ||
| "word_file": "example.docx", | ||
| "mark_text": "AliyunFC", | ||
| "pagesize": [595.275590551181, 841.8897637795275], | ||
| "font": "Helvetica", | ||
| "font_size": 30, | ||
| "font_color": [0, 0, 0], | ||
| "rotate": 30, | ||
| "opacity": 0.1, | ||
| "density": [198.4251968503937, 283.46456692913387] | ||
| } | ||
| ``` | ||
|
|
||
| | 参数 | 是否必填 | 描述 | | ||
| |----------|----------------|------------------| | ||
| | word_file | 必填 | pdf文件名称 | | ||
| | mark_text | 可选 | 水印文字， 如果给 PDF 加水印 | | ||
| | pagesize | 可选 | 默认是 A4 大小， (21*cm, 29.7*cm), 其中 1cm=28.346456692913385 | | ||
| | font | 可选 | 字体，默认为 Helvetica, 中文字体可选择为 zenhei 或 microhei | | ||
| | font_size | 可选 | 字体的大小，默认为 30 | | ||
| | font_color | 可选 | 字体颜色，格式为 RGB， 默认为黑色 | | ||
| | rotate | 可选 | 旋转角度，默认为 0 | | ||
| | opacity | 可选 | 透明度，默认为 0.1， 1 表示不透明 | | ||
| | density | 可选 | 水印密度，水印文字间隔，默认是 [141.73228346456693, 141.73228346456693]，即（7*cm, 10*cm), 表示每个水印文字在横坐标和纵坐标的间隔分别是 7cm 和 10 | | ||
|
|
||
| 3、单击测试函数，函数执行成功后，查看返回结果。 | ||
|
|
||
| ```bash | ||
| upload to oss success! | ||
| ``` | ||
|
|
||
| 如果您需要使用 SDK 调用这个函数， 可以参考 [OpenAPI](https://next.api.aliyun.com/api/FC) | ||
|
|
||
| 也可以通过`s invoke`命令进行触发/测试： | ||
|
|
||
| ```bash | ||
| # 调用 | ||
| $ s invoke -e '{"word_file":"example.docx"}' | ||
| ``` | ||
|
|
||
| 函数调用成功后，生成的 pdf 文件在和 docx 相同的 OSS 目录中，比如这个例子是在 example.pdf。 | ||
|
|
||
| 如果您想 word 转 pdf 同时再加上水印， 需要增加如下相关的参数： | ||
|
|
||
|
|
||
|
|
||
| 比如: | ||
| ```bash | ||
| $ s invoke -e '{"word_file":"example.docx", "mark_text": "AliyunFC", "rotate":30}' | ||
|
|
||
| # 如果是中文水印, font 为 zenhei 或者 microhei | ||
| $ s invoke -e '{"word_file":"example.docx", "mark_text": "函数计算", "rotate":30, "font": "zenhei"}' | ||
| ``` | ||
|
|
||
| 生成带有水印的 example.pdf 示例: | ||
|
|
||
|  | ||
|
|
||
|
|
||
| #### layer | ||
|
|
||
| 引入的 public layer 包含了 libreoffice 以及如下 python 第三方依赖 | ||
|
|
||
| ``` | ||
| oss2==2.16.0 | ||
| flask==2.2.2 | ||
| Pillow==9.4.0 | ||
| PyPDF2==3.0.1 | ||
| reportlab==3.6.12 | ||
| cryptography==3.4.8 | ||
| urllib3==1.26.2 | ||
| ``` | ||
|
|
||
| </usedetail> | ||
|
|
||
| ## 注意事项 | ||
|
|
||
| <matters id="flushContent"> | ||
| </matters> | ||
|
|
||
|
|
||
| <devgroup> | ||
|
|
||
|
|
||
| ## 开发者社区 | ||
|
|
||
| 您如果有关于错误的反馈或者未来的期待，您可以在 [Serverless Devs repo Issues](https://github.com/serverless-devs/serverless-devs/issues) 中进行反馈和交流。如果您想要加入我们的讨论组或者了解 FC 组件的最新动态，您可以通过以下渠道进行： | ||
|
|
||
| <p align="center"> | ||
|
|
||
| | <img src="https://serverless-article-picture.oss-cn-hangzhou.aliyuncs.com/1635407298906_20211028074819117230.png" width="130px" > | <img src="https://serverless-article-picture.oss-cn-hangzhou.aliyuncs.com/1635407044136_20211028074404326599.png" width="130px" > | <img src="https://images.devsapp.cn/fc-faq/33947367.png" width="130px" > | | ||
| | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | | ||
| | <center>微信公众号：`serverless`</center> | <center>微信小助手：`xiaojiangwh`</center> | <center>钉钉交流群：`33947367`</center> | | ||
| </p> | ||
| </devgroup> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| services: #服务变量 | ||
| word2pdf: | ||
| ossBucket: | ||
| title: OSS 存储桶名 | ||
| type: string | ||
| default: "" | ||
| description: OSS 存储桶名 | ||
| x-bucket: | ||
| dependency: | ||
| - region |