Metadata-Version: 2.1
Name: baselib
Version: 1.1.0.2a0
Summary: base common lib for python
Home-page: https://github.com/coreylam/base_common_lib
Author: coreylam
Author-email: coreylam@163.com
License: GPL
Requires-Python: >=2.7
Description-Content-Type: text/markdown
License-File: LICENSE

# base_common_lib
常用的基础通用Lib集合

## 快速入门

### 安装
``` shell script
pip install baselib
```

### 【模块】log
1. 创建日志文件
```python
from baselib.log import file_logger
# 生成 logger 对象，默认自定义了日期格式，以及按天做日志分割
logger = file_logger("文件路径+名称")

logger.info("info msg")
logger.debug("debug msg")
```

### 【模块】json
1. json文件读写，更新
```python
from baselib.json import JsonFile

# 获取json格式文件，当读取异常时返回空的dict
data = JsonFile.read("文件路径+名称")

# 写入json格式文件
JsonFile.write("文件路径+名称", data)

# 直接更新文件，不需要先调用read
JsonFile.update("文件路径+名称", {"1": 2})
```

### 【模块】time
1. 日期段计算 period （简化datetime的调用）

```python
from baselib.time import Period
# 获取近一个小时的起止时间
start_time, end_time = Period.get_recent_hour(1)

# 获取当前时间
now = Period.now()

# 将当前时间转换格式
now_str = Period.formate_datetime(now)
```

### 【模块】system
1. 执行系统命令，并获取返回结果，可以设置是否后台执行，超时时间
```python
from baselib import system

# 执行命令行命令
system.run_cmd("pwd")

# 可以设置是否后台执行，超时时间等
system.run_cmd("ping 8.8.8.8", deamon=False, timeout=2)
```

2. 创建目录(多级目录，安全创建)，不存在时创建，存在时跳过，不会报错
```python
from baselib import system

system.mkdirs("/xxx/yyy/zzz")

```

3. 检查文件是否存在

```python
from baselib import system
system.check_file("xxxx/xxx") 
# 返回检查结果： File， Directory， NotExists
```

### 【模块】qywx
1. 发送企业微信机器人消息

```python
from baselib.qywx import QyWechat
key = "xxxxxxx"  # robot key
robot = QyWechat(key=key, is_ssl=True, debug=True)
robot.send_markdown(
    msg="# Hello world\n> msg from robot",
    page_type=robot.EnumPageType.SPLIT_BY_LINES
)
```
