rite 0.2.1

Python Utility Package

Python Utility Package

rites to write py right

---

Report a Bug | Request a Feature | Ask a Question | Make a Sugestion | Start a Discussion

---

Table of Contents

• About
• Features
• Quick Start
  • Installation
  • Basic Usage
• Documentation
• Contributing
• Authors
• License
• Disclaimer

---

About

rite is a modern Python utility library with zero external runtime dependencies. Built with Python 3.10+ in mind, it provides a comprehensive collection of utilities for cryptography, filesystem operations, text processing, collections, conversions, and more.

Key Features

• Zero Dependencies: No external runtime dependencies
• Type Safe: Comprehensive type hints with Python 3.10+ syntax
• Well Tested: >80% code coverage with extensive test suite
• Modern Python: Supports Python 3.10, 3.11, 3.12
• Modular Design: Clear module organization with consistent structure
• Fully Documented: Extensive documentation and practical examples

Module Overview

Core Modules:

• crypto: UUID generation, hashing (SHA-256, MD5, BLAKE2), HMAC, cryptographic utilities
• filesystem: File/directory operations, path utilities, safe file handling
• text: Slug generation, case conversion, text sanitization, text analysis
• collections: List/dictionary utilities, data structures, iteration helpers
• conversion: Type conversions, data format transformations (JSON, CSV)
• numeric: Mathematical utilities, statistics, number operations
• temporal: Date/time utilities, timestamp operations, formatting

---

Quick Start

Installation

From PyPI:

pip install rite

Using Poetry:

poetry add rite

From Source:

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

View on PyPI

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 slug_generate
from rite.text.case import case_to_snake

slug = slug_generate("Hello World!")  # 'hello-world'
snake = case_to_snake("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]

---

Documentation

User Documentation

• Getting Started - Quick introduction and module overview
• Installation Guide - Detailed installation instructions
• Usage Examples - Practical examples for all modules
• API Reference - Complete API documentation

Developer Documentation

• Contributing Guide - How to contribute to Rite
• Development Setup - Set up your development environment
• Code Style Guide - Code standards and conventions
• Testing Guide - Testing practices and patterns
• Configuration Reference - Configuration files and settings

AI Agent Documentation

• AI Instructions - Guidelines for AI agents and GitHub Copilot

Additional Resources

• Changelog - Version history and release notes
• Architecture - System architecture overview
• Security Policy - Security guidelines and reporting
• License - MIT License details

---

Authors

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.

• website: scape.agency
• github: github.com/scape-agency

---

Contributing

We'd love for you to contribute and to make rite even better than it is today! Please refer to the contribution guidelines for details on:

• Code of conduct
• Development workflow
• Code standards
• Testing requirements
• Pull request process

Quick start for contributors:

# Clone the repository
git clone https://github.com/scape-agency/rite.git
cd rite

# Install dependencies
poetry install --with dev

# Install pre-commit hooks
poetry run pre-commit install

# Run tests
make test

# Run all checks
make check

---

License

Except where otherwise noted, rite is licensed under the terms of the MIT License.

---

Disclaimer

THIS SOFTWARE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.

---

Made with ♥ by Scape Agency
_{Copyright 2026 Scape Agency. All Rights Reserved}