true-core 0.1.1

A boilerplate utility package

True Core

A comprehensive utility toolkit designed for Python developers seeking clean, efficient, and maintainable solutions.

Documentation | PyPI Package | Issue Tracker

---

🚀 Quick Start

pip install true-core

from true.toolkits import simple_debugger
from true.collections import Directory

# Quick example
simple_debugger("Starting application...")
work_dir = Directory("./workspace")

📋 Table of Contents

• Features
• Installation
• Documentation
• Module Overview
• Usage Examples
• Contributing
• License

✨ Features

• 🛡 Robust Error Handling

  • Comprehensive exception hierarchy
  • Custom exception classes
  • Error recovery mechanisms

• 📝 Advanced Logging

  • Built on top of loguru
  • Configurable logging strategies
  • Console and file logging support

• 🔧 Developer Tools

  • Performance profiling
  • Debugging utilities
  • Type checking helpers
  • Retry mechanisms

• ⚡ High Performance

  • Optimized collections
  • Efficient file operations
  • Smart caching capabilities

📦 Installation

Prerequisites

• Python 3.7 or higher
• pip or poetry (recommended)

# Using pip
pip install true-core

# Using poetry
poetry add true-core

# From source
git clone https://github.com/alaamer12/true.git
cd true
pip install -r requirements.txt

📚 Documentation

Comprehensive documentation is available in multiple formats:

• Online Documentation
• API Reference
• Module Documentation
• Examples

🔍 Module Overview

Core Components

# File Operations
from true.collections import File, Directory
workspace = Directory("./workspace")

# Performance Monitoring
from true.toolkits import profile
@profile
def expensive_operation():
    pass

Available Modules

• collections: File system operations and data structures
• exceptions: Comprehensive error handling
• log: Advanced logging capabilities
• toolkits: Developer utilities and helpers
• types: Type definitions and validation
• time: Time manipulation utilities

🚀 Usage Examples

Error Handling

from true.collections import File
import logging

logger = logging.getLogger(__name__)

def read_secure_file(path: str) -> str:
    try:
        file = File(path)
        return file.read_text()
    except FileNotFoundError as e:
        logger.error(f"File not found: {e}")
        return ""

Performance Monitoring

from true.toolkits import monitor

@monitor
def process_data(items: list):
    for item in items:
        # Processing logic here
        pass

🤝 Contributing

We welcome contributions! Here's how you can help:

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Development Setup

# Clone repository
git clone https://github.com/alaamer12/true.git
cd true

# Install dependencies with poetry
poetry install

# Run tests
poetry run pytest

📝 License

This project is licensed under the MIT License - see the LICENSE.md file for details.

---

Made with ❤️ by True Core Team