Skip to content

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:

Services

Business logic and core functionality:

Commands

CLI command implementations:

UI Components

Terminal user interface elements:

  • Menu: Interactive menu system
  • Prompt: User input prompts
  • Header: Application header display

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

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.