init dipper

devsapp · Aug 26, 2024 · 59924f4 · 59924f4
1 parent 3a1bfbf
commit 59924f4
Show file tree

Hide file tree

Showing 6 changed files with 204 additions and 33 deletions.
diff --git a/.github/workflows/registry-publish.yml b/.github/workflows/registry-publish.yml
@@ -1,8 +1,9 @@
 name: publish package to registry
 
 on:
-  release:
-    types: [created]
+  push:
+    branches:
+      - dipper
 
 jobs:
   deploy:

diff --git a/publish.yaml b/publish.yaml
@@ -1,11 +1,11 @@
 Edition: 3.0.0
 Type: Project
-Name: start-word2pdf-v3
+Name: start-word2pdf-dipper
 Provider:
   - 阿里云
-Version: 0.0.6
+Version: 0.0.1
 Description: 本案例是将 word 转 pdf 的逻辑封装成一个python函数，快速创建并部署到阿里云函数计算 FC。
-HomePage: https://github.com/devsapp/start-word2pdf
+HomePage: https://github.com/devsapp/start-word2pdf/tree/dipper
 Organization: 阿里云函数计算（FC）
 Effective: Public
 Tags:

diff --git a/readme.md b/readme.md
@@ -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) ，[![Deploy with Severless Devs](https://img.alicdn.com/imgextra/i1/O1CN01w5RFbX1v45s8TIXPz_!!6000000006118-55-tps-95-28.svg)](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、部署成功后，从资源信息栏，找到对应函数资源，点击函数名称跳转到函数计算控制台，如：
+![](https://img.alicdn.com/imgextra/i3/O1CN01eEXqJ81VdeoZvQKwI_!!6000000002676-0-tps-1212-468.jpg)
+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 示例:
+
+![](https://img.alicdn.com/imgextra/i4/O1CN01xJymEK1MP9YHRBkQx_!!6000000001426-2-tps-652-841.png)
+
+
+#### 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>
diff --git a/src/readme.md b/src/readme.md
@@ -1,18 +1,7 @@
 
 > 注：当前项目为 Serverless Devs 应用，由于应用中会存在需要初始化才可运行的变量（例如应用部署地区、函数名等等），所以**不推荐**直接 Clone 本仓库到本地进行部署或直接复制 s.yaml 使用，**强烈推荐**通过 `s init ${模版名称}` 的方法或应用中心进行初始化，详情可参考[部署 & 体验](#部署--体验) 。
 
-# start-word2pdf-v3 帮助文档
-<p align="center" class="flex justify-center">
-    <a href="https://www.serverless-devs.com" class="ml-1">
-    <img src="http://editor.devsapp.cn/icon?package=start-word2pdf-v3&type=packageType">
-  </a>
-  <a href="http://www.devsapp.cn/details.html?name=start-word2pdf-v3" class="ml-1">
-    <img src="http://editor.devsapp.cn/icon?package=start-word2pdf-v3&type=packageVersion">
-  </a>
-  <a href="http://www.devsapp.cn/details.html?name=start-word2pdf-v3" class="ml-1">
-    <img src="http://editor.devsapp.cn/icon?package=start-word2pdf-v3&type=packageDownload">
-  </a>
-</p>
+# start-word2pdf-dipper 帮助文档
 
 <description>
 
@@ -22,7 +11,7 @@
 
 <codeUrl>
 
-- [:smiley_cat: 代码](https://github.com/devsapp/start-word2pdf/tree/V3/src)
+
 
 </codeUrl>
 <preview>
@@ -62,17 +51,11 @@
 
 <appcenter>
 
-- :fire: 通过 [Serverless 应用中心](https://fcnext.console.aliyun.com/applications/create?template=start-word2pdf-v3) ，
-  [![Deploy with Severless Devs](https://img.alicdn.com/imgextra/i1/O1CN01w5RFbX1v45s8TIXPz_!!6000000006118-55-tps-95-28.svg)](https://fcnext.console.aliyun.com/applications/create?template=start-word2pdf-v3) 该应用。
+:fire: 通过 [Dipper 应用中心](https://devs.console.aliyun.com/applications/createtemplate=start-word2pdf-dipper) ，[![Deploy with Severless Devs](https://img.alicdn.com/imgextra/i1/O1CN01w5RFbX1v45s8TIXPz_!!6000000006118-55-tps-95-28.svg)](https://devs.console.aliyun.com/applications/createtemplate=start-word2pdf-dipper) 该应用。
 
 </appcenter>
 <deploy>
-
-- 通过 [Serverless Devs Cli](https://www.serverless-devs.com/serverless-devs/install) 进行部署：
-  - [安装 Serverless Devs Cli 开发者工具](https://www.serverless-devs.com/serverless-devs/install) ，并进行[授权信息配置](https://docs.serverless-devs.com/fc/config) ；
-  - 初始化项目：`s init start-word2pdf-v3 -d start-word2pdf-v3`
-  - 进入项目，并进行项目部署：`cd start-word2pdf-v3 && s deploy -y`
-
+
 </deploy>
 
 ## 案例介绍
@@ -174,10 +157,6 @@ cryptography==3.4.8
 urllib3==1.26.2
 ```
 
-### 二次开发
-
-您可以通过云端控制台的开发功能进行二次开发。如果您之前是在本地创建的项目案例，也可以在本地项目目录`start-word2pdf-v3`文件夹下，对项目进行二次开发。开发完成后，可以通过`s deploy`进行快速部署。
-
 </usedetail>
 
 ## 注意事项
@@ -195,7 +174,7 @@ urllib3==1.26.2
 
 <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://serverless-article-picture.oss-cn-hangzhou.aliyuncs.com/1635407252200_20211028074732517533.png" width="130px" > |
+| <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>

diff --git a/src/s.yaml b/src/s.yaml
@@ -3,9 +3,10 @@ name: word2pdf
 access: '{{ access }}'
 vars:
   region: '{{ region }}'
+
 resources:
   word2pdf:
-    component: fc3@0.0.34
+    component: fc3
     props:
       region: ${vars.region}
       runtime: custom

diff --git a/src/variable.yaml b/src/variable.yaml
@@ -0,0 +1,10 @@
+services: #服务变量
+  word2pdf: 
+    ossBucket:
+      title: OSS 存储桶名
+      type: string
+      default: ""
+      description: OSS 存储桶名
+      x-bucket:
+        dependency:
+          - region