带有舒适易用 Web UI 的 Python 任务调度程序
现已提供非官方的中文版本
官方网站 (英文) »
非官方网站 (中文) »
GitHub
·
报告错误
Plombery 是一个开源的 Python 任务调度程序，带有简洁易用的 Web UI 和 REST API。 如果你想重复执行 Python 脚本并监控运行状态，那么这便是适合你的工具！
Plombery 项目尚处于起步阶段，因此可以通过大家的反馈和帮助来改进和完善！
如果你喜欢它，请为原始的 Plombery 项目点点 Star 🌟!
如果你想要某个功能或发现错误，请提交 issue。
Plombery 是一个允许定时执行 Python 脚本的项目， 并且自带一个美观的 Web UI 进行可视化控制
相比于其它开源调度项目， Plombery 构造语法简单，并且没有其它复杂的设计或概念， 并且完全开源，不需要考虑任何付费内容
但由于 Plombery 项目并不支持 i18n， 我手动修改了项目内硬编码的文本， 将 Web UI 和邮件文本更改为中文页面
此外，Plombery 项目的文档也进行了汉化， 其中补充说明了本中文项目额外添加的配置项
- ⏰ 基于 APScheduler 的任务调度功能 (支持 Interval，Cron 和 Date 触发器)
- 💻 内置 Web UI, 无需额外使用 HTML/JS/CSS 进行开发
- 👩💻🐍 仅用纯 Python 语法定义管道和任务
- 🎛️ 可以使用 Pydantic 为管道提供参数
- 👉 可以在 Web UI 中手动运行管道
- 🔐 可以设置 OAuth2 提供保护
- 🔍 通过日志和输出数据便捷调试每次运行
- 📩 对管道进行监控，并在出现问题时收到告警通知
- 💣 使用 REST API 进行集成开发
什么时候不该使用:
- 你需要很高的可扩展性，并且希望在分布式系统上运行
- 你想要一个无代码工具，或者你不想使用 Python 进行编写
(返回顶部)
(返回顶部)
单击进入 👉 中文文档 快速入门 Plombery。
在 GitHub Codespaces 上使用演示管道尝试 Plombery:
Codespaces 是一个运行在云中的开发环境，因此你无需克隆、安装依赖等便可以运行， 操作流程如下:
- 前往 yhdsl/plombery GitHub 页面
- 点击右上角绿色的 Code 按钮
- 选择 Codespaces 页面
- 点击 create new codespace from main 或使用已有的代码空间
- 接下来会打开一个
github.dev页面, 请等待环境搭建 - 当代码空间准备完成后，你会看到一个类似 VSCode 的页面
- 一些代码将在终端内执行以构建前端页面等，请耐心等待
- 如果一切顺利，一个 Plombery 页面将在新标签页中打开
- 任何对 Python 代码的更改均会实时相应在 Plombery 页面内，就像在你本地的笔记本电脑上开发一样
这是一个极简的管道代码:
查看 issues 页面 获取完整的建议的功能 (和已知的错误) 清单。
(返回顶部)
正是诸多贡献者的努力让开源社区成为了学习、启发和创造的绝佳场所。 我们非常感谢你的任何贡献。
如果你有任何改进的建议，请 fork 原始的 Plombery 仓库并为其创建 pull request。 你也可以直接创建一个带有 "enhancement" 标签的 issue。 别忘了给原始的 Plombery 项目点点 Star！再次感谢！
- Fork 项目
- 创建你的新功能分叉 (
git checkout -b feature/AmazingFeature) - 提交你的修改 (
git commit -m 'Add some AmazingFeature') - 向分支推送修改 (
git push origin feature/AmazingFeature) - 创建一个 Pull Request
(返回顶部)
克隆此 repo 的一个分支并设置开发环境。
创建一个 python 虚拟环境:
python -m venv .venv
# 使用 Mac/Linux 操作系统
source .venv/bin/activate
# 使用 Win 操作系统
.venv/Script/activate并安装依赖项:
pip install -r requirements.txt
pip install -r requirements-dev.txt本中文项目已经补齐了原始的 Plombery 仓库中丢失的
requirements.txt文件
当前你也可以从pyproject.toml中安装
出于开发的目的，运行示例程序将很有帮助:
cd examples/
# 为示例程序创建一个虚拟环境
python -m venv .venv
source .venv/bin/activate
pip install -r requirements
./run.sh
# 或者在 Win 操作系统上使用 ./run.ps1React 前端位于 frontend/ 文件夹下，
进入该文件夹并安装依赖:
cd frontend/
# 原始的 Plombery 仓库使用 yarn 做为包管理器
# 接下来的命令将安装依赖项
# 如果你是克隆的本中文仓库
# 请改用下面的 npm 命令
yarn或者
cd frontend/
# 如果你是克隆的本中文仓库
# 请改用 npm 命令
npm install运行开发服务器:
yarn dev或者
npm run dev构建前端
yarn run build或者
npm run build文档网站基于 MkDocs Material 开发，
其中源代码位于 docs/ 文件夹下，
而配置储存在 mkdocs.yml 文件内。
要运行本地开发服务器，请执行:
mkdocs serve
测试套件基于 pytest编写，因此仅需执行:
pytest为了获取测试覆盖率，请执行:
coverage run -m pytest
coverage report -m本中文项目与原始的 Plombery 仓库一样， 采用 MTL 协议发布。
请参阅本中文项目和原始 Plombery 仓库下的 LICENSE.txt 文件获取更多信息。
(返回顶部)
- 原始 Plombery 项目: https://github.com/lucafaggianelli/plombery
- 本中文项目: https://github.com/yhdsl/plombery
(返回顶部)
Plombery 建立在以下令人惊叹的技术之上:
(返回顶部)