| Name | happy-core JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | A boilerplate utility package |
| upload_time | 2024-11-26 15:34:10 |
| maintainer | None |
| docs_url | None |
| author | alaamer12 |
| requires_python | <4.0,>=3.11 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Happy Core
<div align="center">
[](https://choosealicense.com/licenses/mit/)
[](https://badge.fury.io/py/happy-core)
[](docs/build/html/index.html)
<p align="center">
<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
# Logging
from happy_core.log import ConsoleLogger
logger = ConsoleLogger.get_logger()
# File Operations
from happy_core.collections import File, Directory
workspace = Directory("./workspace")
# Error Handling
from happy_core.exceptions import ValidationError
try:
# Your code here
except ValidationError as e:
logger.error(f"Validation failed: {e}")
# Performance Monitoring
from happy_core.toolkits import profile, monitor
@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.exceptions import FileNotFoundError
from happy_core.collections import File
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.md) file for details.
---
<div align="center">
Made with ❤️ by [Happy Core Team](https://github.com/alaamer12)
</div>
Raw data
{
"_id": null,
"home_page": null,
"name": "happy-core",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": null,
"author": "alaamer12",
"author_email": "ahmedmuhmmed239@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f0/a4/245612724f6c6d5c9ac26cad7740cfbc9e576eb5b40c8ba1a91449d84e28/happy_core-0.1.0.tar.gz",
"platform": null,
"description": "# Happy Core\n\n<div align=\"center\">\n\n\n[](https://choosealicense.com/licenses/mit/)\n[](https://badge.fury.io/py/happy-core)\n[](docs/build/html/index.html)\n\n<p align=\"center\">\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# Logging\nfrom happy_core.log import ConsoleLogger\nlogger = ConsoleLogger.get_logger()\n\n# File Operations\nfrom happy_core.collections import File, Directory\nworkspace = Directory(\"./workspace\")\n\n# Error Handling\nfrom happy_core.exceptions import ValidationError\ntry:\n # Your code here\nexcept ValidationError as e:\n logger.error(f\"Validation failed: {e}\")\n\n# Performance Monitoring\nfrom happy_core.toolkits import profile, monitor\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.exceptions import FileNotFoundError\nfrom happy_core.collections import File\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.md) file for details.\n\n---\n\n<div align=\"center\">\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.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "da9c8c557fee92e2b8852d1b916d863a5b987e0947433ac4099308d4f47a4178",
"md5": "a6c1b3d1a248f8e66654f20d6d95ac51",
"sha256": "97dfbe544038f4d3552bab060b5cf378c83304214de4c8936308aa907f630e3e"
},
"downloads": -1,
"filename": "happy_core-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a6c1b3d1a248f8e66654f20d6d95ac51",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 53805,
"upload_time": "2024-11-26T15:34:08",
"upload_time_iso_8601": "2024-11-26T15:34:08.425591Z",
"url": "https://files.pythonhosted.org/packages/da/9c/8c557fee92e2b8852d1b916d863a5b987e0947433ac4099308d4f47a4178/happy_core-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f0a4245612724f6c6d5c9ac26cad7740cfbc9e576eb5b40c8ba1a91449d84e28",
"md5": "c1dd49f164093244b5d6b2114ab1836c",
"sha256": "5bbcc465b1bb19d2097335b972d21f32306241751ed30dab56e5ef8f6ceb0a56"
},
"downloads": -1,
"filename": "happy_core-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "c1dd49f164093244b5d6b2114ab1836c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 50040,
"upload_time": "2024-11-26T15:34:10",
"upload_time_iso_8601": "2024-11-26T15:34:10.451216Z",
"url": "https://files.pythonhosted.org/packages/f0/a4/245612724f6c6d5c9ac26cad7740cfbc9e576eb5b40c8ba1a91449d84e28/happy_core-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-26 15:34:10",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "happy-core"
}
