Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 17 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# WeCom CLI 🚀

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![PyPI](https://img.shields.io/pypi/v/api-wecom-cli.svg)](https://pypi.org/project/api-wecom-cli/)
[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

Expand All @@ -21,11 +22,21 @@
## 📦 安装

```bash
pip install -e .
pip install api-wecom-cli
```

*要求 Python >= 3.11*

<details>
<summary>开发安装</summary>

```bash
pip install -e ".[dev]"
pre-commit install
```

</details>

## 🚀 快速上手

配置凭证(支持环境变量或配置文件):
Expand Down Expand Up @@ -68,17 +79,8 @@ wecom customers list-follow-users

## 🛠️ 开发者指南

我们使用 `pre-commit` 来保障代码质量。

```bash
# 安装开发依赖
pip install -e ".[dev]"

# 安装并激活 pre-commit hooks
pre-commit install

# 手动运行全量检查
pre-commit run --all-files
pre-commit run --all-files # 提交前必跑
```

### 自动化脚本
Expand Down Expand Up @@ -106,3 +108,7 @@ pre-commit run --all-files
## 📄 开源协议

本项目采用 [MIT License](LICENSE) 开源。

## 🌐 社区

- [LINUX DO](https://linux.do/) — 开发者社区,项目起步于此
Loading