Feishu API Python SDK V2

介绍

该 SDK 旨在简化与飞书 API 的交互。通过使用此 SDK，开发人员可以轻松地调用飞书的各种 API 接口，而无需处理底层的 HTTP 请求和响应。

安装

你可以通过以下命令安装此 SDK：

pip install feishu-utils-v2

快速开始

初始化客户端

from feishu_utils_v2 import FeishuClient

# 初始化客户端
client = FeishuClient(
    app_id="your_app_id",
    app_secret="your_app_secret"
)

功能模块

该 SDK 包含以下主要功能模块：

• 消息管理：发送消息、获取消息历史等
• 通讯录管理：部门和员工信息管理
• 文档管理：文档的创建、编辑、权限管理等
• 表格操作：电子表格的读写操作
• 会议室管理：会议室预订、查询等
• 日历管理：日程创建、修改、查询等

示例用法

发送消息

# 发送文本消息
response = client.message.send_text(
    receive_id="user_id",
    content="Hello, World!",
    receive_id_type="open_id"
)

# 发送富文本消息
response = client.message.send_rich_text(
    receive_id="user_id",
    title="标题",
    content=[{"text": "正文内容"}],
    receive_id_type="open_id"
)

获取部门信息

# 获取部门列表
departments = client.contact.get_department_list()

# 获取部门详情
department_info = client.contact.get_department_info("department_id")

文档

详细的 API 文档请访问：[API 文档链接]

贡献指南

我们欢迎社区贡献！如果你想为项目做出贡献，请：

1. Fork 本仓库
2. 创建你的特性分支 (git checkout -b feature/AmazingFeature)
3. 提交你的更改 (git commit -m 'Add some AmazingFeature')
4. 推送到分支 (git push origin feature/AmazingFeature)
5. 开启一个 Pull Request

许可证

该项目采用 MIT 许可证 - 查看 LICENSE 文件了解详情

现在让我们创建项目的基本结构。首先创建 setup.py：

```python:feishu-utils-v2/setup.py
from setuptools import setup, find_packages

setup(
    name="feishu-utils-v2",
    version="0.1.0",
    packages=find_packages(),
    install_requires=[
        "requests>=2.25.0",
        "pydantic>=1.8.0",
        "python-dateutil>=2.8.0",
    ],
    author="Your Name",
    author_email="[email protected]",
    description="A Python SDK for Feishu (Lark) API V2",
    long_description=open("README.md").read(),
    long_description_content_type="text/markdown",
    url="https://github.com/yourusername/feishu-utils-v2",
    classifiers=[
        "Development Status :: 3 - Alpha",
        "Intended Audience :: Developers",
        "License :: OSI Approved :: MIT License",
        "Programming Language :: Python :: 3",
        "Programming Language :: Python :: 3.7",
        "Programming Language :: Python :: 3.8",
        "Programming Language :: Python :: 3.9",
    ],
    python_requires=">=3.7",
)

项目的基本框架：

feishu-utils-v2/
├── README.md
├── setup.py
├── requirements.txt
├── feishu_utils/
│   ├── __init__.py
│   ├── client.py
│   ├── auth.py
│   ├── message/
│   │   ├── __init__.py
│   │   └── api.py
│   ├── contact/
│   │   ├── __init__.py
│   │   └── api.py
│   ├── document/
│   │   ├── __init__.py
│   │   └── api.py
│   └── utils/
│       ├── __init__.py
│       └── http.py
├── tests/
│   ├── __init__.py
│   ├── test_client.py
│   └── test_auth.py
└── examples/
    └── basic_usage.py