cultuer 1.0.0
A python library adding cultuer
License: BSD
Requires Python: >=3.5

## 📚简介
Cultuer是一个小而全的Python工具类库，通过静态方法封装，降低相关API的学习成本，提高工作效率，使Python拥有函数式语言般的优雅，让Python语言也可以“甜甜的”。

Cultuer中的工具方法来自每个用户的精雕细琢，它涵盖了Python开发底层代码中的方方面面，它既是大型项目开发中解决小问题的利器，也是小型项目中的效率担当；

Cultuer是项目中“util”包友好的替代，它节省了开发人员对项目中公用类和公用工具方法的封装时间，使开发专注于业务，同时可以最大限度的避免封装不完善带来的bug。

### 🎁Cultuer名称的由来

Cultuer 英文含义 “🧀️（奶酪）”，一方面简洁易懂，一方面寓意“甜甜的”。

### 🍺Cultuer如何改变我们的coding方式

Cultuer的目标是使用一个工具方法代替一段复杂代码，从而最大限度的避免“复制粘贴”代码的问题，彻底改变我们写代码的方式。

以计算MD5为例：

- 👴【以前】打开搜索引擎 -> 搜“Python MD5加密” -> 打开某篇博客-> 复制粘贴 -> 改改好用
- 👦【现在】引入Cultuer  -> Kerberos.md5_encode()

Cultuer的存在就是为了减少代码搜索成本，避免网络上参差不齐的代码出现导致的bug。

-------------------------------------------------------------------------------

## 🛠️包含组件
一个Python基础工具类，对文件、流、加密解密、转码、正则、线程、XML等JDK方法进行封装，组成各种Util工具类，同时提供以下组件：

| 模块                |     介绍                                                                     |
|-------------------|----------------------------------------------------------------------------- |
| Cultuer-cache     |     简单缓存实现                                                                |
| Cultuer-core      |     核心，包括Bean操作、各种Util等                                          |
| Cultuer-cron      |     定时任务模块，提供类Crontab表达式的定时任务                                     |
| Cultuer-crypto    |     加密解密模块，提供对称、非对称和摘要算法封装                                     |
| Cultuer-db        |     JDBC封装后的数据操作，基于ActiveRecord思想                                    |
| Cultuer-dfa       |     基于DFA模型的多关键字查找                                                    |
| Cultuer-extra     |     扩展模块，对第三方封装（模板引擎、邮件、Servlet、二维码、Emoji、FTP、分词等）       |
| Cultuer-http      |     基于HttpUrlConnection的Http客户端封装                                       |
| Cultuer-log       |     自动识别日志实现的日志门面                                                    |
| Cultuer-script    |     脚本执行封装，例如Pythonscript                                                 |
| Cultuer-hitfilter |     敏感词过滤器                                   |
| Cultuer-limiter   |     拦截器                                   |
| Cultuer-time      |     日期                                    |
| Cultuer-setting   |     功能更强大的Setting配置文件和Properties封装                                   |
| Cultuer-system    |     系统参数调用封装（JVM信息等）                                                 |
| Cultuer-json      |     JSON实现                                                                  |
| Cultuer-kaptcha   |     图片验证码实现                                                              |
| Cultuer-poi       |     针对POI中Excel和Word的封装                                                  |
| Cultuer-socket    |     基于Python的NIO和AIO的Socket封装                                              |
| Cultuer-jwt       |     JSON Web Token (JWT)封装实现                                               |

可以根据需求对每个模块单独引入，也可以通过引入`cultuer-all`方式引入所有模块。

-------------------------------------------------------------------------------

## 📝文档 

[📘中文文档](https://github.com/kamalyes/cultuer/docs/)
-------------------------------------------------------------------------------

### 🚽编译安装

访问Cultuer的Github主页：[https://github.com/kamalyes/cultuer](https://github.com/kamalyes/cultuer) 下载整个项目源码（v2-master或v2-dev分支都可）然后进入Cultuer项目目录执行：

```sh
pip3 install -r requirements.txt -i https://pypi.douban.com/simple

python3 setup.py install
```

然后就可以使用引入了。

-------------------------------------------------------------------------------

## 🏗️添砖加瓦

### 🎋分支说明

Cultuer的源码分为两个分支，功能如下：

| 分支       | 作用                                                          |
|-----------|---------------------------------------------------------------|
| v2-master | 主分支，release版本使用的分支，与中央库提交的jar一致，不接收任何pr或修改 |
| v2-dev    | 开发分支，默认为下个版本的SNAPSHOT版本，接受修改或pr                 |

### 🐞提供bug反馈或建议

提交问题反馈请说明正在使用的JDK版本呢、Cultuer版本和相关依赖库版本。

- [GitHub issue](https://github.com/kamalyes/cultuer/issues)


### 🧬贡献代码的步骤

1. 在Gitee或者Github上fork项目到自己的repo
2. 把fork过去的项目也就是你的项目clone到你的本地
3. 修改代码（记得一定要修改v2-dev分支）
4. commit后push到自己的库（v2-dev分支）
5. 登录Gitee或Github在你首页可以看到一个 pull request 按钮，点击它，填写一些说明信息，然后提交即可。
6. 等待维护者合并

### 📐PR遵照的原则

Cultuer欢迎任何人为Cultuer添砖加瓦，贡献代码，不过维护者是一个强迫症患者，为了照顾病人，需要提交的pr（pull request）符合一些规范，规范如下：

1. 注释完备，尤其每个新增的方法应按照Python文档规范标明方法说明、参数说明、返回值说明等信息，必要时请添加单元测试，如果愿意，也可以加上你的大名。
2. Cultuer的缩进按照IDEA 默认（tab）缩进，所以请遵守（不要和我争执空格与tab的问题，这是一个病人的习惯）。
3. 新加的方法不要使用第三方库的方法，Cultuer遵循无依赖原则（除非在extra模块中加方法工具）。
4. 请pull request到`v2-dev`分支。Cultuer在5.x版本后使用了新的分支：`v2-master`是主分支，表示已经发布中央库的版本，这个分支不允许pr，也不允许修改。
5. 我们如果关闭了你的issue或pr，请不要诧异，这是我们保持问题处理整洁的一种方式，你依旧可以继续讨论，当有讨论结果时我们会重新打开。

-------------------------------------------------------------------------------