MarkTools

创建虚拟环境

python -m venv marktools.venv

marktools.venv\Scripts\activate

# 通过conda创建虚拟环境
conda create --name marktools python=3.10.11
conda init
conda activate marktools
conda install python=3.10.11


# 删除虚拟环境
conda deactivate
conda remove --name marktools --all

安装依赖

pip install -r requirements.txt
# 编译样式
## 一次性编译
npm run build:css
## 实时编译（在开发时候开启这个命令，会根据项目中的样式文件变化，实时编译styles.css文件）
npx postcss static/css/main.css -o static/css/styles.css --watch

## 清空依赖
开发时测试了一堆没用的包，可以全部清空
python uninstall_all.py

启动项目

# 普通启动
flask --app app run
# 调试模式
flask --app app run --debug

# 单元测试
## 测试所有
pytest
## 测试单个文件
pytest tests/translate_test.py
## 测试单个测试函数
pytest tests/translate_test.py::test_translate_text

构建docker镜像

# 登录到Docker Hub
docker login

# 打包镜像
docker build -f docker/Dockerfile -t fb208/marktools:0.5.5 .

# 推送镜像到Docker Hub
docker push fb208/marktools:0.5.5

# 运行docker镜像
docker run -p 5000:5000 \
    -e SECRET_KEY=my_secret_key \
    -e OPENAI_API_KEY=my_openai_api_key \
    -e OPENAI_BASE_URL=https://api.deepseek.com/v1/ \
    my_flask_app

# docker-compose启动
见docker-compose-template.yml

关于google cloud

若使用google cloud的服务，需要安装google cloud sdk，神tm麻烦

安装

# windows powershell 执行
(New-Object Net.WebClient).DownloadFile("https://dl.google.com/dl/cloudsdk/channels/rapid/GoogleCloudSDKInstaller.exe", "$env:Temp\GoogleCloudSDKInstaller.exe")

& $env:Temp\GoogleCloudSDKInstaller.exe

安装完多一个Cloud Tools for PowerShell

获取身份验证文件

1. 登录Google Cloud Console (https://console.cloud.google.com/)
2. 选择您的项目
3. 在左侧菜单中，导航到"IAM & Admin" > "Service Accounts"
4. 如果您还没有服务账号，点击页面顶部的"CREATE SERVICE ACCOUNT"创建一个新的服务账号。如果已有服务账号，跳到第7步。
5. 填写服务账号详情（名称、描述等）
6. 为服务账号分配适当的角色（例如，对于Cloud Storage，可能需要"Storage Object Viewer"或"Storage Object Creator"等角色）
7. 在服务账号列表中，找到您想使用的服务账号
8. 点击该服务账号的电子邮件地址，进入服务账号详情页面
9. 在"Keys"标签页下，点击"ADD KEY" > "Create new key"
10. 选择"JSON"作为密钥类型，然后点击"CREATE"
11. 浏览器将自动下载JSON密钥文件。请将此文件保存在安全的位置，因为它包含了访问您Google Cloud资源的凭证。
12. 将下载的文件重命名为更易识别的名称（例如my-project-credentials.json），并记住其保存位置
13. 获取文件后，您可以在代码中使用这个文件路径：

key_path = "path/to/your/my-project-credentials.json"
credentials = service_account.Credentials.from_service_account_file(key_path)

14. 环境变量设置方法

  set GOOGLE_APPLICATION_CREDENTIALS=path\to\your\my-project-credentials.json

使用

# 初始化
gcloud init

其他

项目包很大很大，因为使用了本地的embeeding模型，所以包会很大，如果想要减小包的大小，可以考虑使用在线的embedding服务，比如openai的api，不过需要修改代码了

chromadb不能安装问题

在windows上安装chromadb会报错，需要安装build tools，可以参考https://visualstudio.microsoft.com/visual-cpp-build-tools/

然后在build-tools中选择下面两项进行安装

和

关于word插件

安装

首先共享项目中/word-plugin文件夹 添加everyone用户，配置读写权限

复制共享文件夹的“网络路径”

打开word，进入选项--信任中心--信任中心设置--受信任的加载项

在目录(url)中输入共享文件夹的网络路径，点击“添加目录”，勾选“显示在菜单中”，然后点击“确定”

在“开始”处点击“加载项”

添加更多加载项

如果之前的共享文件夹设置正确，这里就应该出现“共享文件夹”选项，切换进去可以看到“许愿池乌龟”

开发

修改/word-plugin/manifest.xml中的SourceLocation，指向本地开发环境 修改/word-plugin/manifest.xml中的<bt:Url id="Taskpane.Url"，指向本地开发环境

修改完manifest.xml，在加载项中刷新并重新添加加载项，然后重启word

计划

后续使用https://apifox.com/apidoc/shared-f647771e-a7dc-41df-9435-1cac2995bb6a?pwd=9hbXQiO6 替代itchat

三方教程：https://wcg.ymette.com/robot/plugin/starbot/starbot 登录：https://starbot.i1314i.com/index.html#pageid=699