Welcome to Suthing

SUThing /ˈsu.θɪŋ/ or /ˈsʌ.θɪŋ/ (Some Useful Things) is a collection of useful classes and decorators.

A Python utility package providing tools for file handling, timing, profiling, and data comparison.

Features

• File Handling: One-line file reading/writing with file format inference from provided extension (YAML, JSON, CSV, pickle, gz etc.)
• Performance Measurement: Simple timer utilities and profiling decorators
• Data Comparison: Deep comparison of nested data structures
• Error Handling: Decorators for secure function execution and error tracking

Quick Start

from suthing import FileHandle, Timer, equals

# Read a file
data = FileHandle.load("config.yaml")

# Time your code
with Timer() as t:
    # Your code here
    pass
print(f"Execution took {t.elapsed_str}")

# Compare complex structures
result = equals(dict1, dict2)

Documentation

Explore the documentation to learn more about Suthing's features:

• Getting Started - Learn how to install and use Suthing
• API Reference - Complete API documentation
• Examples - Code examples and usage patterns

Requirements

• Python 3.10+
• pandas
• PyYAML
• python-dotenv

Contributing

We welcome contributions! Please check out our Contributing Guide for details on how to get started.