# Asterisk-Task
## 介绍
这是一个任务管理的框架，可以把需要执行的任务在命令行进行执行，配置定时任务、多线程运行的任务等。
可以应用到日常监控、自动化执行等方面。
本项目由上海掌欣信息技术有限公司开发并维护，并在未来开源。
## 发行日志
### V2.0.15
主要完善了新的任务类的实现。新的任务类需要继承AsteriskTask，该类包含了以下类属性，来取代原先使用AppConfig.json来配置的烦恼
* description - 任务的简要说明
* sub_task - 是否是子任务,如果是，则无法独立运行，需要在主任务中调用，这是V2新引入特性
* threading - 是否使用多线程
* is_loop - 是否循环执行
* timer - 定时器的设置，只有在is_loop为True时才有效。period为间隔时间，fixed_time为固定时间
* next_tasks - 后续任务
* abstract_task - 当设定为抽象任务时，不作为具体任务执行。必须有子类的任务才能执行任务，这是V2引入的新特性
### 软件架构
Aterisk-Task以TaskManager作为任务管理器的类，在系统启动时，读入配置文件，读取可以调用任务类，启动默认任务，并启动定时任务。本框架集成了schedule、logging等常用类库。
为了解决关联任务直接的数据传递，以AsteriskContext来实现了类似cookie的功能。
自V2.0以后，任务类做了一次比较大的升级。任务类（除了启动后的默认任务，需要在AppConfig文件中配置意外）将不需要在配置文件中进行配置。
整体架构非常轻。
### 安装教程
1. 在gitee中[发行版](https://e.gitee.com/zhangxin_1/repos/zhangxin_1/asterisk-task/releases/ "Asteristk-Task 框架发行版")下载最新发行版
2. 可以命令行中执行`pip3 install asterisk_task-*.whl`进行安装
### 使用说明
1. 安装成功后,可以使用命令行创建项目，例如创建test_project `atnewapp -app test_project`
2. 系统会自动创建 `test_project` 目录，以及`run_test_project.py`
3. 执行`python3 run_test_project.py`即可启动项目运行。创建项目时会自动设置默认任务。
### 参与贡献
1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
新建 Pull Request
### 特技
1. 使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
Raw data
{
"_id": null,
"home_page": null,
"name": "asterisk-task",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10.0",
"maintainer_email": null,
"keywords": "task, scheduled task",
"author": "Shan,Tian",
"author_email": "geoshan@163.com",
"download_url": null,
"platform": "Independent",
"description": "# Asterisk-Task\n\n## \u4ecb\u7ecd\n\n\u8fd9\u662f\u4e00\u4e2a\u4efb\u52a1\u7ba1\u7406\u7684\u6846\u67b6\uff0c\u53ef\u4ee5\u628a\u9700\u8981\u6267\u884c\u7684\u4efb\u52a1\u5728\u547d\u4ee4\u884c\u8fdb\u884c\u6267\u884c\uff0c\u914d\u7f6e\u5b9a\u65f6\u4efb\u52a1\u3001\u591a\u7ebf\u7a0b\u8fd0\u884c\u7684\u4efb\u52a1\u7b49\u3002\n\u53ef\u4ee5\u5e94\u7528\u5230\u65e5\u5e38\u76d1\u63a7\u3001\u81ea\u52a8\u5316\u6267\u884c\u7b49\u65b9\u9762\u3002\n\n\u672c\u9879\u76ee\u7531\u4e0a\u6d77\u638c\u6b23\u4fe1\u606f\u6280\u672f\u6709\u9650\u516c\u53f8\u5f00\u53d1\u5e76\u7ef4\u62a4\uff0c\u5e76\u5728\u672a\u6765\u5f00\u6e90\u3002\n\n## \u53d1\u884c\u65e5\u5fd7\n\n### V2.0.15\n\n\u4e3b\u8981\u5b8c\u5584\u4e86\u65b0\u7684\u4efb\u52a1\u7c7b\u7684\u5b9e\u73b0\u3002\u65b0\u7684\u4efb\u52a1\u7c7b\u9700\u8981\u7ee7\u627fAsteriskTask\uff0c\u8be5\u7c7b\u5305\u542b\u4e86\u4ee5\u4e0b\u7c7b\u5c5e\u6027\uff0c\u6765\u53d6\u4ee3\u539f\u5148\u4f7f\u7528AppConfig.json\u6765\u914d\u7f6e\u7684\u70e6\u607c\n\n* description - \u4efb\u52a1\u7684\u7b80\u8981\u8bf4\u660e\n* sub_task - \u662f\u5426\u662f\u5b50\u4efb\u52a1,\u5982\u679c\u662f\uff0c\u5219\u65e0\u6cd5\u72ec\u7acb\u8fd0\u884c\uff0c\u9700\u8981\u5728\u4e3b\u4efb\u52a1\u4e2d\u8c03\u7528\uff0c\u8fd9\u662fV2\u65b0\u5f15\u5165\u7279\u6027\n* threading - \u662f\u5426\u4f7f\u7528\u591a\u7ebf\u7a0b\n* is_loop - \u662f\u5426\u5faa\u73af\u6267\u884c\n* timer - \u5b9a\u65f6\u5668\u7684\u8bbe\u7f6e\uff0c\u53ea\u6709\u5728is_loop\u4e3aTrue\u65f6\u624d\u6709\u6548\u3002period\u4e3a\u95f4\u9694\u65f6\u95f4\uff0cfixed_time\u4e3a\u56fa\u5b9a\u65f6\u95f4\n* next_tasks - \u540e\u7eed\u4efb\u52a1\n* abstract_task - \u5f53\u8bbe\u5b9a\u4e3a\u62bd\u8c61\u4efb\u52a1\u65f6\uff0c\u4e0d\u4f5c\u4e3a\u5177\u4f53\u4efb\u52a1\u6267\u884c\u3002\u5fc5\u987b\u6709\u5b50\u7c7b\u7684\u4efb\u52a1\u624d\u80fd\u6267\u884c\u4efb\u52a1\uff0c\u8fd9\u662fV2\u5f15\u5165\u7684\u65b0\u7279\u6027\n\n### \u8f6f\u4ef6\u67b6\u6784\n\nAterisk-Task\u4ee5TaskManager\u4f5c\u4e3a\u4efb\u52a1\u7ba1\u7406\u5668\u7684\u7c7b\uff0c\u5728\u7cfb\u7edf\u542f\u52a8\u65f6\uff0c\u8bfb\u5165\u914d\u7f6e\u6587\u4ef6\uff0c\u8bfb\u53d6\u53ef\u4ee5\u8c03\u7528\u4efb\u52a1\u7c7b\uff0c\u542f\u52a8\u9ed8\u8ba4\u4efb\u52a1\uff0c\u5e76\u542f\u52a8\u5b9a\u65f6\u4efb\u52a1\u3002\u672c\u6846\u67b6\u96c6\u6210\u4e86schedule\u3001logging\u7b49\u5e38\u7528\u7c7b\u5e93\u3002\n\u4e3a\u4e86\u89e3\u51b3\u5173\u8054\u4efb\u52a1\u76f4\u63a5\u7684\u6570\u636e\u4f20\u9012\uff0c\u4ee5AsteriskContext\u6765\u5b9e\u73b0\u4e86\u7c7b\u4f3ccookie\u7684\u529f\u80fd\u3002\n\n\u81eaV2.0\u4ee5\u540e\uff0c\u4efb\u52a1\u7c7b\u505a\u4e86\u4e00\u6b21\u6bd4\u8f83\u5927\u7684\u5347\u7ea7\u3002\u4efb\u52a1\u7c7b\uff08\u9664\u4e86\u542f\u52a8\u540e\u7684\u9ed8\u8ba4\u4efb\u52a1\uff0c\u9700\u8981\u5728AppConfig\u6587\u4ef6\u4e2d\u914d\u7f6e\u610f\u5916\uff09\u5c06\u4e0d\u9700\u8981\u5728\u914d\u7f6e\u6587\u4ef6\u4e2d\u8fdb\u884c\u914d\u7f6e\u3002\n\n\u6574\u4f53\u67b6\u6784\u975e\u5e38\u8f7b\u3002\n\n### \u5b89\u88c5\u6559\u7a0b\n\n1. \u5728gitee\u4e2d[\u53d1\u884c\u7248](https://e.gitee.com/zhangxin_1/repos/zhangxin_1/asterisk-task/releases/ \"Asteristk-Task \u6846\u67b6\u53d1\u884c\u7248\")\u4e0b\u8f7d\u6700\u65b0\u53d1\u884c\u7248\n2. \u53ef\u4ee5\u547d\u4ee4\u884c\u4e2d\u6267\u884c`pip3 install asterisk_task-*.whl`\u8fdb\u884c\u5b89\u88c5\n\n### \u4f7f\u7528\u8bf4\u660e\n\n1. \u5b89\u88c5\u6210\u529f\u540e,\u53ef\u4ee5\u4f7f\u7528\u547d\u4ee4\u884c\u521b\u5efa\u9879\u76ee\uff0c\u4f8b\u5982\u521b\u5efatest_project `atnewapp -app test_project`\n2. \u7cfb\u7edf\u4f1a\u81ea\u52a8\u521b\u5efa `test_project` \u76ee\u5f55\uff0c\u4ee5\u53ca`run_test_project.py`\n3. \u6267\u884c`python3 run_test_project.py`\u5373\u53ef\u542f\u52a8\u9879\u76ee\u8fd0\u884c\u3002\u521b\u5efa\u9879\u76ee\u65f6\u4f1a\u81ea\u52a8\u8bbe\u7f6e\u9ed8\u8ba4\u4efb\u52a1\u3002\n\n### \u53c2\u4e0e\u8d21\u732e\n\n1. Fork \u672c\u4ed3\u5e93\n2. \u65b0\u5efa Feat_xxx \u5206\u652f\n3. \u63d0\u4ea4\u4ee3\u7801\n \u65b0\u5efa Pull Request\n\n### \u7279\u6280\n\n1. \u4f7f\u7528 Readme\\_XXX.md \u6765\u652f\u6301\u4e0d\u540c\u7684\u8bed\u8a00\uff0c\u4f8b\u5982 Readme\\_en.md, Readme\\_zh.md\n2. Gitee \u5b98\u65b9\u535a\u5ba2 [blog.gitee.com](https://blog.gitee.com)\n3. \u4f60\u53ef\u4ee5 [https://gitee.com/explore](https://gitee.com/explore) \u8fd9\u4e2a\u5730\u5740\u6765\u4e86\u89e3 Gitee \u4e0a\u7684\u4f18\u79c0\u5f00\u6e90\u9879\u76ee\n4. [GVP](https://gitee.com/gvp) \u5168\u79f0\u662f Gitee \u6700\u6709\u4ef7\u503c\u5f00\u6e90\u9879\u76ee\uff0c\u662f\u7efc\u5408\u8bc4\u5b9a\u51fa\u7684\u4f18\u79c0\u5f00\u6e90\u9879\u76ee\n5. Gitee \u5b98\u65b9\u63d0\u4f9b\u7684\u4f7f\u7528\u624b\u518c [https://gitee.com/help](https://gitee.com/help)\n6. Gitee \u5c01\u9762\u4eba\u7269\u662f\u4e00\u6863\u7528\u6765\u5c55\u793a Gitee \u4f1a\u5458\u98ce\u91c7\u7684\u680f\u76ee [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Task management system.",
"version": "2.0.23.520.1456",
"project_urls": null,
"split_keywords": [
"task",
" scheduled task"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "58eaaebbe5afb5b08b30afca299f44e4b6b47465863e958aea722c62002df46c",
"md5": "50c555585f5ffc2536b42f2d6dfce633",
"sha256": "aacb2a69a4939080aeb852116c677f7852db5a7abe5236f261be62a4756676db"
},
"downloads": -1,
"filename": "asterisk_task-2.0.23.520.1456-py3-none-any.whl",
"has_sig": false,
"md5_digest": "50c555585f5ffc2536b42f2d6dfce633",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10.0",
"size": 40451,
"upload_time": "2024-05-20T06:57:38",
"upload_time_iso_8601": "2024-05-20T06:57:38.742618Z",
"url": "https://files.pythonhosted.org/packages/58/ea/aebbe5afb5b08b30afca299f44e4b6b47465863e958aea722c62002df46c/asterisk_task-2.0.23.520.1456-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-20 06:57:38",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "asterisk-task"
}
JSON