# 🔮 Magic Utils
| |Badges |
|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Testing | [](https://app.codecov.io/github/MrCode200/magic_utils) [](https://github.com/MrCode200/magic_utils/actions/workflows/codecov-coverage.yml) |
| Package | [](https://pypi.org/project/power-decos/) [](https://pypi.org/project/power-decos/) 
| Meta |[](https://github.com/MrCode200/power_decos/blob/main/LICENSE) 
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)
Raw data
{
"_id": null,
"home_page": "https://github.com/MrCode200/magic_utils",
"name": "magic-utils",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": "keyword1, keyword2",
"author": "MrCode200",
"author_email": "navidyaghmaei@example.com",
"download_url": "https://files.pythonhosted.org/packages/37/25/07a99df396538b9b0ac7d95b7524767ab7974f7196ac0703224d627eba51/magic_utils-0.1.0.tar.gz",
"platform": null,
"description": "\n\n# \ud83d\udd2e Magic Utils\n\n| |Badges |\n|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Testing | [](https://app.codecov.io/github/MrCode200/magic_utils) [](https://github.com/MrCode200/magic_utils/actions/workflows/codecov-coverage.yml) |\n| Package | [](https://pypi.org/project/power-decos/) [](https://pypi.org/project/power-decos/) \n| Meta |[](https://github.com/MrCode200/power_decos/blob/main/LICENSE) \n\n\n\nA useful Libary of classes and functions\n\n### It provides:\n\n- A channel manager (for function to be subscribed to)\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Testing](#testing)\n- [License](LICENSE.txt)\n- [Documentation](#documentation)\n- [Road Map](#road-map)\n- [Discussion and Development](#discussion-and-development)\n- [Call for Contributions](#call-for-contributions)\n- [Credits](#credits)\n- [Getting Help](#getting-help)\n\n### Installation\n\n1. Ensure you have [Python](https://www.python.org/) installed.\n\n ```bash\n pip install git+https://github.com/MrCode200/magic_utils.git \n ```\n ```bash\n pip install magic_utils\n ```\n\n### Testing:\n\n`Magic Utils` requires `pytest`. Tests can then be run after installation:\n- run:`pytest`\n- or run: `poetry run pytest`\n- to get a html coverage review add `--cov-report=html` to the end of `pytest`\n\nNOTE: if it doesn't work try to go inside the folder and then run the commands\n\n## Documentation\n\n- To view documentation in your website click [here](https://raw.githack.com/MrCode200/magic_utils/refs/heads/main/docs/html/index.html).\n\nOr\n\n- Run [index.html](docs/html/index.html) in your browser after cloning this project\n\n\n## Road Map\n\n1. [ ] Generate documentation\n\n\n## Call for Contributions\n\nWe\u2019re excited that you\u2019re interested in contributing to `Magic Utils`! Whether you\u2019re fixing bugs, adding new features, improving documentation, or simply suggesting enhancements, your contributions are invaluable to us.\n\n\nEvery bit helps, and we appreciate your effort and enthusiasm!\n\nPlease refer to our [CONTRIBUTING.md](CONTRIBUTING.md) for more details.\n\n## Credits\n\n- no credits\n\n## Getting Help\n\nFor any questions or support, please first read our [FAQ.md](FAQ.md)\n\nThen contact:\n\n- **Your Name** - [navidyaghmaei@gmail.com](mailto:navidyaghmaei@gmail.com)\n- **Project Link** - [https://github.com/MrCode200/magic_utils](https://github.com/MrCode200/magic_utils)\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Contains useful utilities classes and functions.",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/MrCode200/magic_utils",
"Repository": "https://github.com/MrCode200/magic_utils"
},
"split_keywords": [
"keyword1",
" keyword2"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "601255bf14a22e7a8aa6e7fc756781814e2412bab832f92ae7763a37124bad89",
"md5": "21a980d7e71fadd4edb58d06c54f9f3d",
"sha256": "32427c8fd114d40bf1e4777ed1dc096b8751b89996e3b55d2cb7de3bc4572e95"
},
"downloads": -1,
"filename": "magic_utils-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "21a980d7e71fadd4edb58d06c54f9f3d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 5555,
"upload_time": "2024-09-30T07:28:49",
"upload_time_iso_8601": "2024-09-30T07:28:49.923608Z",
"url": "https://files.pythonhosted.org/packages/60/12/55bf14a22e7a8aa6e7fc756781814e2412bab832f92ae7763a37124bad89/magic_utils-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "372507a99df396538b9b0ac7d95b7524767ab7974f7196ac0703224d627eba51",
"md5": "e201923a37bd324a916086ae5b7e21e1",
"sha256": "5dd2632f5730afb996443b1848f5d318cac1188c14681ed56bff4d7c673b7d64"
},
"downloads": -1,
"filename": "magic_utils-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "e201923a37bd324a916086ae5b7e21e1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 4997,
"upload_time": "2024-09-30T07:28:51",
"upload_time_iso_8601": "2024-09-30T07:28:51.441148Z",
"url": "https://files.pythonhosted.org/packages/37/25/07a99df396538b9b0ac7d95b7524767ab7974f7196ac0703224d627eba51/magic_utils-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-30 07:28:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MrCode200",
"github_project": "magic_utils",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "magic-utils"
}
JSON
