| name | feishu-openapi-dev |
| description | Expert guidance for Feishu (飞书) / Lark OpenAPI Python development. Build Feishu applications, robots, handle event subscriptions, card callbacks, and API integrations. Use when working with Feishu SDK, lark-oapi, building Feishu bots, or mentioning 飞书 development. |
Feishu OpenAPI Python Development Expert
Expert guidance for Feishu (飞书) / Lark Open Platform Python development, covering API calls, event handling, robot development, and more.
📚 Source Documentation
This skill includes three official/community source repositories (managed via git submodule):
1. oapi-sdk-python (Official SDK)
Path: source/oapi-sdk-python/
Official Feishu Python SDK providing complete type system and semantic programming interface.
Core Directories:
lark_oapi/ - SDK core code
samples/ - Official sample code
doc/ - Documentation resources
Main Features:
- Server-side API calls
- Event subscription handling
- Card callback processing
- Automatic access_token management
- Data encryption/decryption and signature verification
2. oapi-sdk-python-compact (Convenience Wrapper)
Path: source/oapi-sdk-python-compact/
Enhanced wrapper based on official SDK, providing convenient shortcut functions.
Core Directories:
src/lark_oapi_compact/shortcut/ - High-level convenience APIs
sheets/ - 电子表格 (Spreadsheet) operations
driver/ - 云文档/云空间 (Drive) operations
group_robot/ - 群机器人 (Group robot) messaging
message/ - Message handling
compact/ - Core configuration
tests/ - Test cases
Configuration Guide: See CLAUDE.md for development setup instructions.
3. lark-samples (Official Examples)
Path: source/lark-samples/
Official Feishu sample code collection with complete scenario-based implementations.
Example Projects:
robot_quick_start/ - Quick start robot development
web_app_with_jssdk/ - 网页应用 (Web app) development
web_app_with_auth/ - Web app with authentication
echo_bot/ - Echo bot (multi-language)
card_interaction_bot/ - Card interaction bot
mcp_larkbot_demo/ - MCP intelligent Agent
mcp_quick_demo/ - MCP quick start
Quick Start
Installation
pip install lark-oapi
pip install lark-oapi-compact
Basic Configuration
import lark_oapi as lark
client = lark.Client.builder() \
.app_id("your_app_id") \
.app_secret("your_app_secret") \
.build()
Environment Variables
Development and testing require these environment variables:
FEISHU_APP_ID - Application ID (应用 ID)
FEISHU_APP_SECRET - Application Secret (应用密钥)
FEISHU_GROUP_ROBOT_WEBHOOK_URL - Group robot Webhook (optional)
Usage Guide
Finding API Usage
- Basic API calls: Check
source/oapi-sdk-python/samples/
- Convenience wrappers: Check
source/oapi-sdk-python-compact/src/lark_oapi_compact/shortcut/
- Complete scenarios: Check corresponding example projects in
source/lark-samples/
Recommended Development Workflow
- Identify your scenario (机器人/robot, 网页应用/web app, API call)
- Find similar examples in
lark-samples
- Use
oapi-sdk-python for API calls
- For complex scenarios, use
oapi-sdk-python-compact shortcut functions
Updating Source
cd source
git submodule update --remote
cd source/oapi-sdk-python
git pull origin v2_main
Official Resources