marvelpy 0.1.0

A fully-typed Python client for the Marvel Comics API.

Marvelpy

A fully-typed Python client for the Marvel Comics API.

Features

• 🚀 Async-first design - Built with modern async/await patterns
• 🔒 Fully typed - Complete type hints for better IDE support
• 📚 Comprehensive - Full coverage of the Marvel Comics API
• 🛡️ Enterprise-ready - Production-grade error handling and retry logic
• 📖 Well documented - Extensive documentation and examples

Quick Start

Installation

pip install marvelpy

Basic Usage

import marvelpy

# Get a hello message
message = marvelpy.hello_world()
print(message)  # "Hello from Marvelpy!"

What's Available

Currently, Marvelpy v0.1.0 includes:

• Hello World Function - Basic demonstration functionality
• Complete test suite - 100% test coverage
• Type safety - Full type hints throughout
• Documentation - Comprehensive docs with examples

Coming Soon

The full Marvel Comics API client will include:

• Characters - Search and retrieve character information
• Comics - Access comic book data and metadata
• Events - Marvel universe events and storylines
• Series - Comic series information
• Stories - Individual story details
• Creators - Creator and artist information

Example Future Usage

# This is planned functionality - not yet implemented
import marvelpy

# Initialize the client
client = marvelpy.MarvelClient(api_key="your_key", private_key="your_private_key")

# Search for characters
characters = await client.characters.search("spider-man")

# Get character details
spiderman = await client.characters.get(1009610)

# Search comics
comics = await client.comics.search("amazing spider-man")

Requirements

• Python 3.8 or higher
• httpx>=0.23.0
• pydantic>=1.10.0
• typing-extensions>=4.9.0
• click>=8.1.0

Development

Setup

git clone https://github.com/jlgranof/marvelpy.git
cd marvelpy
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -e ".[dev]"

Testing

pytest
pytest --cov=marvelpy --cov-report=html

Documentation

mkdocs serve  # Serve docs locally
mkdocs build  # Build docs

Contributing

We welcome contributions! Please see our Contributing Guide for details.

Documentation

• 📖 Full Documentation
• 🚀 Quick Start Guide
• 📚 API Reference
• 🔧 Installation Guide

License

This project is licensed under the MIT License - see the LICENSE file for details.

Links

• PyPI: https://pypi.org/project/marvelpy/
• GitHub: https://github.com/jlgranof/marvelpy
• Documentation: https://jlgranof.github.io/marvelpy/
• Issues: https://github.com/jlgranof/marvelpy/issues

---

Note: This package is currently in early development. The initial release (v0.1.0) includes basic functionality with a hello world example. Full Marvel API integration is coming soon!