API Reference¶

Welcome to the Rite API reference documentation. This section provides detailed documentation for all modules, classes, and functions in the Rite library.

Module Overview¶

Rite is organized into semantic submodules, each focusing on a specific domain:

Core Utilities¶

Collections - Advanced data structures and collection utilities
Conversion - Type conversion and format transformation utilities
Text - Comprehensive text processing and manipulation

System & I/O¶

Filesystem - File and directory operations
System - System-level operations and environment management
Net - Network utilities and URL handling

Data & Serialization¶

Serialization - JSON, CSV, TOML, Pickle, and INI operations
Markup - HTML, XML, and Markdown processing

Security & Data Processing¶

Crypto - Cryptographic operations, hashing, and UUIDs
Numeric - Numerical operations and mathematical utilities
Temporal - Date, time, and duration management

Development & Debugging¶

Diagnostics - Logging, profiling, and error handling
Functional - Functional programming utilities
Reflection - Runtime introspection and dynamic loading

Quick Start¶

from rite.text import to_snake_case, slugify
from rite.filesystem import file_read_text, file_write_text
from rite.crypto import hash_sha256
from rite.temporal import datetime_now

# Text processing
snake = to_snake_case("HelloWorld")  # "hello_world"
slug = slugify("Hello World!")  # "hello-world"

# File operations
content = file_read_text("example.txt")
file_write_text("output.txt", content)

# Cryptography
hashed = hash_sha256("secret data")

# Date/time
now = datetime_now()

Design Principles¶

Zero External Dependencies - Uses only Python standard library
Single Symbol Files - Each file contains one function/class for clarity
Semantic Organization - Intuitive directory structure
Complete Type Hints - Full Python 3.10+ type annotations
Comprehensive Docstrings - Google-style documentation with examples
79-Character Lines - PEP 8 compliant formatting

Browse the API documentation by selecting a module from the navigation menu or use the links above to explore specific functionality.