# py-commons

**Repository Path**: toosimple-tools/py-commons

## Basic Information

- **Project Name**: py-commons
- **Description**: 模仿java代码风格实现的python常用工具
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-10-01
- **Last Updated**: 2021-03-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# py-commons

## 介绍
一些常用的工具类


## 安装教程


### 开发模式安装
git clone https://gitee.com/toosimple-tools/py-commons.git

cd py-commons

pip install -e .

### 从git仓库安装
本项目未发布到pypi上，直接从git仓库安装

pip install -U git+https://gitee.com/toosimple-tools/py-commons.git@master#egg=py-commons


## 使用说明

### 默认配置

默认使用sys.path\[1\]作为项目根目录，须将PYTHONPATH设置为项目根目录

Windows: set PYTHONPATH=\[项目根目录\]

Linux:  export PYTHONPATH=\[项目根目录\]

配置文件默认放在sys.path\[1\]下的resources/private目录，[配置文件样例](resources/config_example.yaml)

日志默认写入到sys.path\[1\]下的logs目录

注：在pycharm中运行debug时可能出现sys.path\[1\]不等于项目根目录的情况，
这时候可能需要覆盖默认的配置


### 覆盖默认配置

默认配置文件放在project_base_dir下的resources/private目录
日志默认写入到sys.path\[1\]下的logs目录

在项目根目录创建config_patch.py文件(参考[config_patch.py](config_patch.py))
按需修改project_base_dir

也可以进一步修改默认的配置文件相对路径patched_rel_log_dir
和日志写入相对路径patched_rel_config_path

## 参与贡献

+ 保持代码风格(变量命名，目录结构等)和整体项目一致

+ 安装black代码格式化工具 pip install black(如果下载报错，可能要先执行 pip uninstall typing)

提交前在项目根目录运行black .

+ 提交 pull request