Skip to content

Rite Documentation

Welcome to the Rite documentation! Rite is a modern Python utility library providing a comprehensive collection of utilities for cryptography, filesystem operations, text processing, collections, conversions, and more.

Features

  • Zero Dependencies: No external runtime dependencies
  • Type Safe: Comprehensive type hints with Python 3.12+ syntax
  • Well Tested: >99% code coverage
  • Modern Python: Python 3.12+ support
  • Modular: Clear module organization with consistent structure
  • Documented: Extensive documentation and examples

Getting Started

API Reference

For Contributors

For AI Agents

Reference

Module Overview

Cryptography (rite.crypto)

UUID generation, hashing (SHA-256, MD5, BLAKE2), HMAC, and cryptographic utilities.

Filesystem (rite.filesystem)

File and directory operations, path utilities, safe file handling.

Text Processing (rite.text)

Slug generation, case conversion, text sanitization, text analysis.

Collections (rite.collections)

List and dictionary utilities, data structures, iteration helpers.

Conversions (rite.conversion)

Type conversions, data format transformations (JSON, CSV, etc.).

Numeric (rite.numeric)

Mathematical utilities, statistics, number operations.

Temporal (rite.temporal)

Date and time utilities, timestamp operations, formatting.

Requirements

  • Python 3.12 or higher
  • No external dependencies

Installation

# Using pip
pip install rite

# Using Poetry
poetry add rite

# From source
git clone https://github.com/scape-agency/rite.git
cd rite
poetry install

Basic Usage

# Cryptography
from rite.crypto.uuid import uuid_hex
from rite.crypto.hash import hash_sha256

user_id = uuid_hex()
password_hash = hash_sha256("secure_password")

# Filesystem
from rite.filesystem.file import file_copy, file_exists

if file_exists("config.json"):
    file_copy("config.json", "config.backup.json")

# Text Processing
from rite.text.slug import slugify
from rite.text.case import to_snake_case

slug = slugify("Hello World!")  # 'hello-world'
snake = to_snake_case("helloWorld")  # 'hello_world'

# Collections
from rite.collections.list import list_unique, list_flatten

unique = list_unique([1, 2, 2, 3])  # [1, 2, 3]
flat = list_flatten([[1, 2], [3, 4]])  # [1, 2, 3, 4]

About Scape Agency

rite is an open-source project by Scape Agency.

Scape Agency is a spatial innovation collective that dreams, discovers and designs the everyday of tomorrow. We blend design thinking with emerging technologies to create a brighter perspective for people and planet. Our products and services naturalise technology in liveable and sustainable –scapes that spark the imagination and inspire future generations.