python-happy-cor


Namepython-happy-cor JSON
Version 0.1.1 PyPI version JSON
download
home_pagehttps://github.com/alaamer12/happy-core
SummaryA boilerplate utility package
upload_time2024-11-27 06:45:58
maintainerNone
docs_urlNone
authoralaamer12
requires_python<4.0,>=3.11
licenseMIT
keywords utilities boilerplate core
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # Happy Core

<div >

![Python Version](https://img.shields.io/badge/python-3.7%2B-blue)
[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)
[![PyPI version](https://badge.fury.io/py/happy-core.svg)](https://badge.fury.io/py/happy-core)
[![Documentation](https://img.shields.io/badge/docs-latest-brightgreen.svg)](docs/build/html/index.html)

<p >
  <img src="https://raw.githubusercontent.com/alaamer12/happy/main/docs/source/_static/logo.png" alt="Happy Core Logo" width="200"/>
</p>

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

[Documentation](docs/build/html/index.html) |
[PyPI Package](https://pypi.org/project/happy-core/) |
[Issue Tracker](https://github.com/alaamer12/happy/issues)

</div>

---

## 🚀 Quick Start

```bash
pip install happy_core
```

```python
from happy_core.toolkits import simple_debugger
from happy_core.collections import Directory

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

## 📋 Table of Contents

- [Features](#-features)
- [Installation](#-installation)
- [Documentation](#-documentation)
- [Module Overview](#-module-overview)
- [Usage Examples](#-usage-examples)
- [Contributing](#-contributing)
- [License](#-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)

```bash
# Using pip
pip install happy_core

# Using poetry
poetry add happy_core

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

## 📚 Documentation

Comprehensive documentation is available in multiple formats:

- [Online Documentation](docs/build/html/index.html)
- [API Reference](docs/build/html/api_reference.html)
- [Module Documentation](docs/build/html/modules.html)
- [Examples](docs/build/html/examples.html)

## 🔍 Module Overview

### Core Components

```python
# File Operations
from happy_core.collections import File, Directory
workspace = Directory("./workspace")

# Performance Monitoring
from happy_core.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

```python
from happy_core.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

```python
from happy_core.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

```bash
# Clone repository
git clone https://github.com/alaamer12/happy.git
cd happy_core

# Install dependencies with poetry
poetry install

# Run tests
poetry run pytest
```

## 📝 License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.txt) file for details.

---

<div >

Made with ❤️ by [Happy Core Team](https://github.com/alaamer12)

</div>

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/alaamer12/happy-core",
    "name": "python-happy-cor",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.11",
    "maintainer_email": null,
    "keywords": "utilities, boilerplate, core",
    "author": "alaamer12",
    "author_email": "ahmedmuhmmed239@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/fa/c3/5a6252ae8280723f8297052fe91043162c4205c033ae9698f25f1b88bf26/python_happy_cor-0.1.1.tar.gz",
    "platform": null,
    "description": "# Happy Core\n\n<div >\n\n![Python Version](https://img.shields.io/badge/python-3.7%2B-blue)\n[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)\n[![PyPI version](https://badge.fury.io/py/happy-core.svg)](https://badge.fury.io/py/happy-core)\n[![Documentation](https://img.shields.io/badge/docs-latest-brightgreen.svg)](docs/build/html/index.html)\n\n<p >\n  <img src=\"https://raw.githubusercontent.com/alaamer12/happy/main/docs/source/_static/logo.png\" alt=\"Happy Core Logo\" width=\"200\"/>\n</p>\n\nA comprehensive utility toolkit designed for Python developers seeking clean, efficient, and maintainable solutions.\n\n[Documentation](docs/build/html/index.html) |\n[PyPI Package](https://pypi.org/project/happy-core/) |\n[Issue Tracker](https://github.com/alaamer12/happy/issues)\n\n</div>\n\n---\n\n## \ud83d\ude80 Quick Start\n\n```bash\npip install happy_core\n```\n\n```python\nfrom happy_core.toolkits import simple_debugger\nfrom happy_core.collections import Directory\n\n# Quick example\nsimple_debugger(\"Starting application...\")\nwork_dir = Directory(\"./workspace\")\n```\n\n## \ud83d\udccb Table of Contents\n\n- [Features](#-features)\n- [Installation](#-installation)\n- [Documentation](#-documentation)\n- [Module Overview](#-module-overview)\n- [Usage Examples](#-usage-examples)\n- [Contributing](#-contributing)\n- [License](#-license)\n\n## \u2728 Features\n\n- **\ud83d\udee1 Robust Error Handling**\n  - Comprehensive exception hierarchy\n  - Custom exception classes\n  - Error recovery mechanisms\n\n- **\ud83d\udcdd Advanced Logging**\n  - Built on top of `loguru`\n  - Configurable logging strategies\n  - Console and file logging support\n\n- **\ud83d\udd27 Developer Tools**\n  - Performance profiling\n  - Debugging utilities\n  - Type checking helpers\n  - Retry mechanisms\n\n- **\u26a1 High Performance**\n  - Optimized collections\n  - Efficient file operations\n  - Smart caching capabilities\n\n## \ud83d\udce6 Installation\n\n### Prerequisites\n- Python 3.7 or higher\n- pip or poetry (recommended)\n\n```bash\n# Using pip\npip install happy_core\n\n# Using poetry\npoetry add happy_core\n\n# From source\ngit clone https://github.com/alaamer12/happy.git\ncd happy_core\npip install -r requirements.txt\n```\n\n## \ud83d\udcda Documentation\n\nComprehensive documentation is available in multiple formats:\n\n- [Online Documentation](docs/build/html/index.html)\n- [API Reference](docs/build/html/api_reference.html)\n- [Module Documentation](docs/build/html/modules.html)\n- [Examples](docs/build/html/examples.html)\n\n## \ud83d\udd0d Module Overview\n\n### Core Components\n\n```python\n# File Operations\nfrom happy_core.collections import File, Directory\nworkspace = Directory(\"./workspace\")\n\n# Performance Monitoring\nfrom happy_core.toolkits import profile\n@profile\ndef expensive_operation():\n    pass\n```\n\n### Available Modules\n\n- **collections**: File system operations and data structures\n- **exceptions**: Comprehensive error handling\n- **log**: Advanced logging capabilities\n- **toolkits**: Developer utilities and helpers\n- **types**: Type definitions and validation\n- **time**: Time manipulation utilities\n\n## \ud83d\ude80 Usage Examples\n\n### Error Handling\n\n```python\nfrom happy_core.collections import File\nimport logging\n\nlogger = logging.getLogger(__name__)\n\ndef read_secure_file(path: str) -> str:\n    try:\n        file = File(path)\n        return file.read_text()\n    except FileNotFoundError as e:\n        logger.error(f\"File not found: {e}\")\n        return \"\"\n```\n\n### Performance Monitoring\n\n```python\nfrom happy_core.toolkits import monitor\n\n@monitor\ndef process_data(items: list):\n    for item in items:\n        # Processing logic here\n        pass\n```\n\n## \ud83e\udd1d Contributing\n\nWe welcome contributions! Here's how you can help:\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n### Development Setup\n\n```bash\n# Clone repository\ngit clone https://github.com/alaamer12/happy.git\ncd happy_core\n\n# Install dependencies with poetry\npoetry install\n\n# Run tests\npoetry run pytest\n```\n\n## \ud83d\udcdd License\n\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE.txt) file for details.\n\n---\n\n<div >\n\nMade with \u2764\ufe0f by [Happy Core Team](https://github.com/alaamer12)\n\n</div>\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A boilerplate utility package",
    "version": "0.1.1",
    "project_urls": {
        "Documentation": "https://happy-core.readthedocs.io",
        "Homepage": "https://github.com/alaamer12/happy-core",
        "Repository": "https://github.com/alaamer12/happy-core"
    },
    "split_keywords": [
        "utilities",
        " boilerplate",
        " core"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d90ee1ed97ce494c49399f1e03dc8ab40e0f4ce36dcef9eda5a2b229801d2f68",
                "md5": "034c82150dc3b16b82646bad4dc8ed93",
                "sha256": "6bb3c74acbc26a164ccfd1e4b2474bb8a911e874d3e501fb803ac1ac1e3e414d"
            },
            "downloads": -1,
            "filename": "python_happy_cor-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "034c82150dc3b16b82646bad4dc8ed93",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.11",
            "size": 53610,
            "upload_time": "2024-11-27T06:45:56",
            "upload_time_iso_8601": "2024-11-27T06:45:56.613828Z",
            "url": "https://files.pythonhosted.org/packages/d9/0e/e1ed97ce494c49399f1e03dc8ab40e0f4ce36dcef9eda5a2b229801d2f68/python_happy_cor-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fac35a6252ae8280723f8297052fe91043162c4205c033ae9698f25f1b88bf26",
                "md5": "0b236c4006b82dc9e5ba7a931063b44d",
                "sha256": "f7ccd40efebce6ff28d410e0bd7cfdb9bbd1bac656a7ea24123116d77bb7ec15"
            },
            "downloads": -1,
            "filename": "python_happy_cor-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "0b236c4006b82dc9e5ba7a931063b44d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.11",
            "size": 50398,
            "upload_time": "2024-11-27T06:45:58",
            "upload_time_iso_8601": "2024-11-27T06:45:58.727210Z",
            "url": "https://files.pythonhosted.org/packages/fa/c3/5a6252ae8280723f8297052fe91043162c4205c033ae9698f25f1b88bf26/python_happy_cor-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-27 06:45:58",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "alaamer12",
    "github_project": "happy-core",
    "github_not_found": true,
    "lcname": "python-happy-cor"
}
alaamer12
Elapsed time: 9.82493s