Developer Guide
Tip
When to read this: When you're ready to develop extensions for ErisPulse—adding features (modules) to the bot or integrating with new platforms (adapters). If you just want to use the bot, skip this and go directly to the Quick Start.
Here you'll find your development path: Module Development allows you to extend the bot's functionality using commands and message processors; Adapter Development enables the bot to connect to new messaging platforms. Both paths cover the full workflow from project creation to testing and deployment.
Table of Contents
Module Development
- Getting Started with Module Development - Create your first module
- Core Concepts of Modules - Core concepts and architecture of modules
- Event Wrapper Class Explained - Complete documentation of the Event object
- Module Best Practices - Recommendations for developing high-quality modules
- Data Model Layer (ORM) - Advanced module development: declarative models, automatic table creation, and CRUD operations
Adapter Development
- Getting Started with Adapter Development - Create your first adapter
- Core Concepts of Adapters - Core concepts of adapters (including two writing styles for start(), and base classes for PollingAdapter / WebhookAdapter connection modes)
- SendDSL Explained - Complete documentation of the Send message sending DSL
- Event Converters - Implementing event converters
- Adapter Best Practices - Recommendations for developing high-quality adapters
Testing & Troubleshooting
- Module Testing (ErisPulse-Testing) - TestBot, event factories, and assertion surfaces
General Standards
- Configuration & UI Metadata - Declarative configuration: widget / conditional visibility / value shape / compatibility contract (applicable to both adapters and modules)
Publishing Guide
- Publishing & Module Store Guide - Publish your work to PyPI and the ErisPulse Module Store
Development Preparation
Before starting development, please ensure that you:
- Read Basic Concepts
- Familiarized yourself with Event Handling
- Installed the development environment (Python >= 3.10)
- Installed the ErisPulse SDK
Development Type Selection
Choose the appropriate development type based on your needs:
| Development Type | Use Case | Getting Started |
|---|---|---|
| Module Development | Extend bot functionality, implement business logic, provide commands and message handling | Getting Started with Module Development |
| Adapter Development | Connect to new messaging platforms, enable cross-platform communication, provide platform-specific features | Getting Started with Adapter Development |
If you want to extend the bot's functionality (such as adding commands or handling messages), choose module development. If you need to connect the bot to a new platform, choose adapter development.
Development Tools
Project Templates
ErisPulse provides example projects for reference:
- Module Example - Complete project structure for a module (Commands / Config / ORM / Dependency Injection)
- Web Capability Example - Route decorators / Middleware / WebSocket hooks / router.app escape hatch
- Advanced Interaction Example - Message transactions and receipts / ORM composite unique constraints and transactions / Request approval / Send chains
- Ops Governance Example - Thread task ownership / Delayed tasks / Memory health checks / Privacy switches
- Adapter Example - Complete project structure for an adapter (also available: Polling / Webhook variants)
Development Mode
Use hot-reload mode for development, which automatically reloads after code changes:
epsdk run main.py --reload
Debugging Tips
Enable DEBUG or TRACE level logging in config/config.toml:
[ErisPulse.logger]
# DEBUG: Outputs development debugging information such as module loading and route registration
# TRACE: Lowest level, outputs detailed internal framework processes such as event dispatching, storage writes, and lazy loading
level = "DEBUG"
Publish Your Module
For the complete publishing process, please refer to the Publishing and Module Store Guide, which includes PyPI publishing steps and the ErisPulse module store submission process.
Related Documentation
- Standards - Technical standards to ensure compatibility
- Platform Features Guide - Learn about the features of each platform adapter