API Reference Overview¶
Welcome to the Weeb CLI API reference documentation. This section provides detailed documentation for all modules, classes, and functions in the codebase.
Organization¶
The API documentation is organized by package:
Core Modules¶
Essential modules that provide foundational functionality:
- Config: Configuration management system
- I18n: Internationalization and localization
- Exceptions: Custom exception hierarchy
Providers¶
Anime source provider implementations:
- Base Provider: Abstract base class and data structures
- Registry: Provider discovery and management
- Turkish Providers: Animecix, Turkanime, Anizle, Weeb
- English Providers: HiAnime, AllAnime
- German Providers: AniWorld
- Polish Providers: Docchi
Services¶
Business logic and core functionality:
- Database: SQLite database management
- Downloader: Queue-based download system
- Tracker: AniList, MAL, Kitsu integration
- Player: MPV player integration
- Cache: Caching system
- Local Library: Local anime management
Commands¶
CLI command implementations:
- API Commands: Non-interactive JSON API
- Search: Anime search functionality
- Downloads: Download management
- Watchlist: Watch history and progress
UI Components¶
Terminal user interface elements:
Quick Links¶
Common Tasks¶
Type Hints¶
All modules use comprehensive type hints for better IDE support and code clarity:
from typing import List, Optional, Dict
def search(query: str) -> List[AnimeResult]:
"""Search with full type information."""
pass
Docstring Style¶
We use Google-style docstrings throughout:
def function(param: str) -> bool:
"""Short description.
Args:
param: Parameter description.
Returns:
Return value description.
Example:
>>> function("test")
True
"""
pass
Navigation¶
Use the sidebar to navigate through the API documentation. Each page includes:
- Module overview
- Class and function signatures
- Detailed descriptions
- Usage examples
- Type information
Contributing¶
Found an issue with the documentation? Please open an issue or submit a pull request.