Contributing to Magick Mind SDK

For SDK Users

If you're looking to use the SDK, see the main README.

For SDK Contributors

This section is for developers who want to extend the SDK by adding new resources, features, or improvements.

Extending the SDK

Want to add typed resource clients (e.g., client.chat.send(...))? The SDK provides authentication and HTTP client foundation - you can build on top of it.

See Resource Implementation Guide for a complete reference implementation showing:

• ✅ Pydantic models for request/response validation
• ✅ Version-aware resource classes (v1, v2)
• ✅ Clean namespace pattern (client.v1.chat, client.v2.chat)
• ✅ Working usage examples

This serves as a template for adding chat, history, users, or any other resources to the SDK.

Project Structure

magick_mind/
├── auth/           # Authentication providers
├── http/           # HTTP client
├── models/         # Pydantic request/response models
├── resources/      # API resource clients
├── config.py       # Configuration
└── exceptions.py   # Error hierarchy

Development Setup

# Clone the repo
git clone <repo-url>
cd py-magickmind

# Install with dev dependencies
uv sync

# Run tests
uv run pytest

Guidelines

• Follow existing patterns - See magick_mind/resources/README.md
• Use versioned folders - models/v1/, resources/v1/ etc.
• Add type hints - All functions should have type annotations
• Write tests - Add tests for new functionality
• Update docs - Keep README and docstrings up to date

Questions?

Open an issue or discuss in the project's communication channels.