magic-utils 0.1.0
Contains useful utilities classes and functions.
License: MIT
Requires Python: <4.0,>=3.11
Keywords: keyword1, keyword2

![Project Logo](https://imgs.search.brave.com/lPl-BWFfBCvh025FDErfp0uAWDvVYXzi_YjqXf3AjRM/rs:fit:860:0:0:0/g:ce/aHR0cHM6Ly9jZG5h/Lmljb25zY291dC5j/b20vaW1nL2V4Y2x1/c2l2ZS4xZTFiZTQ3/LnN2Zw)

# 🔮 Magic Utils

|         |Badges                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Testing | [![CI - Test](https://img.shields.io/codecov/c/github/MrCode200/magic_utils?logo=codecov&label=Coverage)](https://app.codecov.io/github/MrCode200/magic_utils) [![Run tests and upload coverage](https://github.com/MrCode200/magic_utils/actions/workflows/codecov-coverage.yml/badge.svg)](https://github.com/MrCode200/magic_utils/actions/workflows/codecov-coverage.yml) ![Python-Coverage](https://img.shields.io/badge/pytest-covered-blue?logo=pytest)|
| Package | [![PyPI Latest Release](https://img.shields.io/pypi/v/power-decos)](https://pypi.org/project/power-decos/) [![PyPI Downloads](https://img.shields.io/pypi/dm/power-decos.svg?label=PyPI%20downloads)](https://pypi.org/project/power-decos/) ![Forks](https://img.shields.io/github/forks/MrCode200/power_decos?style=flat&label=Forks)
| Meta    |[![License - MIT](https://img.shields.io/github/license/MrCode200/power_decos)](https://github.com/MrCode200/power_decos/blob/main/LICENSE) ![Poetry](https://img.shields.io/badge/poetry-managed-blue)



A useful Libary of classes and functions

### It provides:

- A channel manager (for function to be subscribed to)

## Table of Contents

- [Installation](#installation)
- [Testing](#testing)
- [License](LICENSE.txt)
- [Documentation](#documentation)
- [Road Map](#road-map)
- [Discussion and Development](#discussion-and-development)
- [Call for Contributions](#call-for-contributions)
- [Credits](#credits)
- [Getting Help](#getting-help)

### Installation

1. Ensure you have [Python](https://www.python.org/) installed.

   ```bash
    pip install git+https://github.com/MrCode200/magic_utils.git   
   ```
   ```bash
    pip install magic_utils
   ```

### Testing:

`Magic Utils` requires `pytest`. Tests can then be run after installation:
- run:`pytest`
- or run: `poetry run pytest`
- to get a html coverage review add `--cov-report=html` to the end of `pytest`

NOTE: if it doesn't work try to go inside the folder and then run the commands

## Documentation

- To view documentation in your website click [here](https://raw.githack.com/MrCode200/magic_utils/refs/heads/main/docs/html/index.html).

Or

- Run [index.html](docs/html/index.html) in your browser after cloning this project


## Road Map

1. [ ] Generate documentation


## Call for Contributions

We’re excited that you’re interested in contributing to `Magic Utils`! Whether you’re fixing bugs, adding new features, improving documentation, or simply suggesting enhancements, your contributions are invaluable to us.


Every bit helps, and we appreciate your effort and enthusiasm!

Please refer to our [CONTRIBUTING.md](CONTRIBUTING.md) for more details.

## Credits

- no credits

## Getting Help

For any questions or support, please first read our [FAQ.md](FAQ.md)

Then contact:

- **Your Name** - [navidyaghmaei@gmail.com](mailto:navidyaghmaei@gmail.com)
- **Project Link** - [https://github.com/MrCode200/magic_utils](https://github.com/MrCode200/magic_utils)