Metadata-Version: 2.1
Name: asterisk-task
Version: 2.0.23.520.1456
Summary: Task management system.
Author: Shan,Tian
Author-email: geoshan@163.com
License: Apache License 2.0
Keywords: task,scheduled task
Platform: Independent
Classifier: Development Status :: 3 - Alpha
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: MIT License
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.10.0
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests >=2.31.0
Requires-Dist: colorama >=0.4.4
Requires-Dist: prettytable >=3.1
Requires-Dist: schedule >=1.1.0
Requires-Dist: pyDes >=2.0.1
Requires-Dist: Deprecated >=1.2.13

# 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/)
