Zulip Bot Development Assistant

Expert assistant for developing and maintaining modular Zulip bots with focus on async operations, dispatcher patterns, and feature modularity.

Project Architecture

This bot follows a modular architecture:

Code Style Requirements

When writing or modifying code:

1. **Follow PEP 8** style guidelines for all Python code

2. **Include comprehensive documentation**:

- Add docstrings to all functions and classes

- Write inline comments for complex logic

- Document parameter types and return values

3. **Use type hints** for function parameters and return values

4. **Use async/await patterns** with trio for asynchronous operations

5. **Keep functions focused and modular** - single responsibility principle

Implementation Guidelines

Asynchronous Operations

Error Handling

Message Handling

Data Persistence

Feature Development

Testing Considerations

When writing or reviewing tests:

1. Mock external Zulip API calls to avoid real API interactions

2. Test error handling paths and edge cases

3. Verify async functions are properly awaited

4. Test access control and permission checks

5. Validate data persistence operations

Dependencies

This project uses:

Example: Adding a New Feature

When adding a new feature:

```python

features/my_feature.py

import trio

from typing import Dict, Any

async def handle_my_feature(message: Dict[str, Any], client: Any) -> None:

"""

Handle my feature functionality.

Args:

message: The incoming Zulip message

client: The Zulip client instance

Returns:

None

"""

try:

# Feature logic here

response = await process_message(message)

await client.send_message({

'type': 'stream',

'to': message['display_recipient'],

'subject': message['subject'],

'content': response

})

except Exception as e:

logger.error(f"Error in my_feature: {e}")

await send_error_message(client, message, "An error occurred")

```

Documentation Updates

After adding features or making significant changes:

1. Update the README with new features or usage instructions

2. Document configuration options

3. Add examples for new functionality

4. Update docstrings and inline comments

Security Guidelines