| Name | pyhappy JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | A boilerplate utility package |
| upload_time | 2024-11-08 14:22:57 |
| 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.
|
readme_content = """
# Happy Project
## Overview
`Happy` is a modular and feature-rich package boilerplate code that is
designed to solve a simple yet impactful problems .The project is designed to be highly maintainable,
extensible, and, flexible,
with a focus on clean code principles
and optimization.
`Happy` will have a lot of different extensions in the future.
## Table of Contents
- [Content](#Content)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [License](#license)
## Content
The project includes multiple modules with a clear separation of concerns:
- **Log**: Provide a different logging strategies [e.g. ConsoleLogger], built on the top of loguru.
- **Collections**: Collection of helper functions and classes.
- **Toolkit**: Collection of simple yet fast functions and classes.
- **Re**: Collection of regular expressions (regex patterns) for common data validation tasks across a variety of fields.
- **Time**: Collection of time-related functions and classes.
- **Types**: Collection of types used across the project.
## Features
- **Console Logging**: Using the `ConsoleLogger` class, the application can log messages to the console for debugging
and runtime monitoring.
- **IDE Compatibility**: The `FixIDEComplain` class prevents IDE complaints about unimplemented methods while keeping
the codebase functional.
- **Modular Design**: The project is broken down into independent modules for easier testing, maintenance, and
scalability.
- **High Performance**: The project uses efficient data structures and algorithms to optimize performance.
- **Type Checking**: The project uses type hints to enforce strong typing and provide better documentation.
## Installation
To install and run the `happy` project locally, follow these steps:
### Prerequisites
- Python 3.7+
### Steps
1. Clone the repository:
```bash
git clone https://github.com/alaamer12/happy.git
cd pyhappy
```
2. Install dependencies:
```bash
pip install -r requirements.txt
```
or install the project as a package:
```bash
pip install pyhappy
```
## Usage
### Toolkits
The `toolkits` module provides a collection of utility functions, decorators, and context managers for various tasks.
```python
from pyhappy.toolkits import simple_debugger, profile, check_internet_connectivity, monitor, Constants, retry
myconstants = Constants(a=1, b=2)
# Example usage
simple_debugger('Hello, World!')
def my_function():
pass
my_function()
# Example usage
@profile
def my_function():
pass
my_function()
# Example usage
check_internet_connectivity("https://www.google.com")
# Example usage
@monitor
def my_function():
pass
my_function()
# Example usage
@retry
def my_function():
pass
my_function()
```
## License
The `happy` project is licensed under the MIT License.
Raw data
{
"_id": null,
"home_page": null,
"name": "pyhappy",
"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/b3/b3/0aa515031aa1a290d9bf03ca145b0b2fd5ef9631ad5a7c15acfc7fc5a092/pyhappy-0.1.0.tar.gz",
"platform": null,
"description": "readme_content = \"\"\"\n\n# Happy Project\n\n## Overview\n\n`Happy` is a modular and feature-rich package boilerplate code that is\ndesigned to solve a simple yet impactful problems .The project is designed to be highly maintainable,\nextensible, and, flexible,\nwith a focus on clean code principles\nand optimization.\n\n`Happy` will have a lot of different extensions in the future.\n\n## Table of Contents\n\n\n- [Content](#Content)\n- [Features](#features)\n- [Installation](#installation)\n- [Usage](#usage)\n- [License](#license)\n\n## Content\nThe project includes multiple modules with a clear separation of concerns:\n\n- **Log**: Provide a different logging strategies [e.g. ConsoleLogger], built on the top of loguru.\n- **Collections**: Collection of helper functions and classes.\n- **Toolkit**: Collection of simple yet fast functions and classes.\n- **Re**: Collection of regular expressions (regex patterns) for common data validation tasks across a variety of fields.\n- **Time**: Collection of time-related functions and classes.\n- **Types**: Collection of types used across the project.\n\n## Features\n- **Console Logging**: Using the `ConsoleLogger` class, the application can log messages to the console for debugging\n and runtime monitoring.\n- **IDE Compatibility**: The `FixIDEComplain` class prevents IDE complaints about unimplemented methods while keeping\n the codebase functional.\n- **Modular Design**: The project is broken down into independent modules for easier testing, maintenance, and\n scalability.\n- **High Performance**: The project uses efficient data structures and algorithms to optimize performance.\n- **Type Checking**: The project uses type hints to enforce strong typing and provide better documentation.\n\n\n## Installation\n\nTo install and run the `happy` project locally, follow these steps:\n\n### Prerequisites\n\n- Python 3.7+\n\n### Steps\n\n1. Clone the repository:\n ```bash\n git clone https://github.com/alaamer12/happy.git\n cd pyhappy\n ```\n\n2. Install dependencies:\n ```bash\n pip install -r requirements.txt\n ```\n\nor install the project as a package:\n\n ```bash\n pip install pyhappy\n ```\n## Usage\n\n### Toolkits\n\nThe `toolkits` module provides a collection of utility functions, decorators, and context managers for various tasks.\n\n```python\nfrom pyhappy.toolkits import simple_debugger, profile, check_internet_connectivity, monitor, Constants, retry\n\nmyconstants = Constants(a=1, b=2)\n\n# Example usage\nsimple_debugger('Hello, World!')\n\n\ndef my_function():\n pass\n\n\nmy_function()\n\n\n# Example usage\n@profile\ndef my_function():\n pass\n\n\nmy_function()\n\n# Example usage\ncheck_internet_connectivity(\"https://www.google.com\")\n\n\n# Example usage\n@monitor\ndef my_function():\n pass\n\n\nmy_function()\n\n\n# Example usage\n@retry\ndef my_function():\n pass\n\n\nmy_function()\n```\n\n## License\n\nThe `happy` project is licensed under the MIT License.\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": "66bd30701fb90c7d91861c08d9c0f7044d6ed57d7a2b3557acac7eef6e44e613",
"md5": "05cc1ee91cfb4cc19d777433c40b4b0a",
"sha256": "a0b1b398c44a50901b0801bfc52fe26b45eb333d86107c2eb23284b6261d9ec7"
},
"downloads": -1,
"filename": "pyhappy-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "05cc1ee91cfb4cc19d777433c40b4b0a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 52230,
"upload_time": "2024-11-08T14:22:55",
"upload_time_iso_8601": "2024-11-08T14:22:55.124974Z",
"url": "https://files.pythonhosted.org/packages/66/bd/30701fb90c7d91861c08d9c0f7044d6ed57d7a2b3557acac7eef6e44e613/pyhappy-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b3b30aa515031aa1a290d9bf03ca145b0b2fd5ef9631ad5a7c15acfc7fc5a092",
"md5": "b3cd83fc11d9f9e33b7142a79294f42a",
"sha256": "8ebf32c1da5d46dee20b4263fda1369983f35a8a8020dbe92d2af1c9ec03e76d"
},
"downloads": -1,
"filename": "pyhappy-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "b3cd83fc11d9f9e33b7142a79294f42a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 47119,
"upload_time": "2024-11-08T14:22:57",
"upload_time_iso_8601": "2024-11-08T14:22:57.165259Z",
"url": "https://files.pythonhosted.org/packages/b3/b3/0aa515031aa1a290d9bf03ca145b0b2fd5ef9631ad5a7c15acfc7fc5a092/pyhappy-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-08 14:22:57",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pyhappy"
}
