| Name | fluxutils JSON |
| Version |
1.2.0.1
JSON |
| download |
| home_page | None |
| Summary | Various utilties to enhance your projects |
| upload_time | 2024-08-07 05:12:39 |
| maintainer | None |
| docs_url | None |
| author | dombom |
| requires_python | >=3.12 |
| license | MIT License Copyright (c) 2024 DomBom16 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
utils
logger
log
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# FluxUtils
FluxUtils is a powerful, highly customizable, and versatile Python module designed to enhance the efficiency and performance of your programs. Whether you're a seasoned developer or just starting out, FluxUtils offers a suite of tools to streamline your workflow and improve code management. FluxUtils currently enables developers with a simple yet highly customizable logger with support for multiple streams, a set of utility decorators, like `@cache` and `@rate_limiter`, and a handful of tools to create a command-line interface with interactive prompts and argument handling.
- [FluxUtils](#fluxutils)
- [Installation](#installation)
- [Documentation](#documentation)
- [Contributing](#contributing)
- [Testing](#testing)
- [Versioning](#versioning)
- [License](#license)
- [Support](#support)
## Installation
FluxUtils requires Python 3.12 or higher. To install the latest version, use pip:
```sh
pip install fluxutils
```
This command will download and install FluxUtils along with its dependencies.
## Documentation
- [Changelog](docs/changelog.md)
- [Decorators Module](docs/modules/decorators.md)
- [CLI Module](docs/modules/cli.md)
- [Log Module](docs/modules/log.md)
## Contributing
Contributions to FluxUtils are welcome! Whether you're fixing bugs, improving documentation, or proposing new features, your efforts are appreciated. Here's how you can contribute:
1. **Fork & Clone the Repository**: Start by forking the FluxUtils repository on GitHub. Clone your fork to your local machine for development.
```zsh
git clone https://github.com/<your-name>/fluxutils.git
```
2. **Create a Branch**: Create a new branch for your feature or bug fix.
```zsh
git checkout -b feature/your-feature-name
```
3. **Make Your Changes & Test**: Implement your feature or bug fix. Be sure to test it before continuing.
4. **Update Documentation**: If your changes require it, update the README and any relevant documentation.
5. **Commit Your Changes**: Commit your changes with a clear and descriptive commit message.
```zsh
git commit -m "Add feature: your feature description"
```
6. **Push to Your Fork**: Push your changes to your fork on GitHub.
```zsh
git push origin feature/your-feature-name
```
7. **Create a Pull Request**: Go to the FluxUtils repository on GitHub and create a new pull request from your feature branch.
Please ensure your code adheres to the project's coding standards and includes appropriate documentation. We appreciate your contribution!
## Testing
FluxUtils uses unittest for its test suite. We encourage contributors to write tests for new features and bug fixes. The `fluxutils/tests/decorators/test1.py` provides a good example of how to structure tests.
## Versioning
FluxUtils follows [Semantic Versioning](https://semver.org/). The version number is structured as MAJOR.MINOR.PATCH:
- MAJOR version increments denote incompatible API changes,
- MINOR version increments add functionality in a backwards-compatible manner, and
- PATCH version increments are for backwards-compatible bug fixes.
## License
FluxUtils is released under the MIT License. See the [LICENSE](LICENSE) file for more details.
<!-- ## Acknowledgements
We would like to thank all the contributors who have helped to make FluxUtils better. Your time and effort are greatly appreciated. -->
## Support
If you encounter any issues or have questions about using FluxUtils, please file an issue on the [GitHub issue tracker](https://github.com/DomBom16/fluxutils/issues).
Raw data
{
"_id": null,
"home_page": null,
"name": "fluxutils",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "utils, logger, log",
"author": "dombom",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/84/84/207415ddcbfe181c7ca7c67cdaf665e99e23297cfeb95ac86d627dd6f10c/fluxutils-1.2.0.1.tar.gz",
"platform": null,
"description": "# FluxUtils\n\nFluxUtils is a powerful, highly customizable, and versatile Python module designed to enhance the efficiency and performance of your programs. Whether you're a seasoned developer or just starting out, FluxUtils offers a suite of tools to streamline your workflow and improve code management. FluxUtils currently enables developers with a simple yet highly customizable logger with support for multiple streams, a set of utility decorators, like `@cache` and `@rate_limiter`, and a handful of tools to create a command-line interface with interactive prompts and argument handling.\n\n- [FluxUtils](#fluxutils)\n - [Installation](#installation)\n - [Documentation](#documentation)\n - [Contributing](#contributing)\n - [Testing](#testing)\n - [Versioning](#versioning)\n - [License](#license)\n - [Support](#support)\n\n## Installation\n\nFluxUtils requires Python 3.12 or higher. To install the latest version, use pip:\n\n```sh\npip install fluxutils\n```\n\nThis command will download and install FluxUtils along with its dependencies.\n\n## Documentation\n\n- [Changelog](docs/changelog.md)\n- [Decorators Module](docs/modules/decorators.md)\n- [CLI Module](docs/modules/cli.md)\n- [Log Module](docs/modules/log.md)\n\n## Contributing\n\nContributions to FluxUtils are welcome! Whether you're fixing bugs, improving documentation, or proposing new features, your efforts are appreciated. Here's how you can contribute:\n\n1. **Fork & Clone the Repository**: Start by forking the FluxUtils repository on GitHub. Clone your fork to your local machine for development.\n\n ```zsh\n git clone https://github.com/<your-name>/fluxutils.git\n ```\n\n2. **Create a Branch**: Create a new branch for your feature or bug fix.\n\n ```zsh\n git checkout -b feature/your-feature-name\n ```\n\n3. **Make Your Changes & Test**: Implement your feature or bug fix. Be sure to test it before continuing.\n4. **Update Documentation**: If your changes require it, update the README and any relevant documentation.\n5. **Commit Your Changes**: Commit your changes with a clear and descriptive commit message.\n\n ```zsh\n git commit -m \"Add feature: your feature description\"\n ```\n\n6. **Push to Your Fork**: Push your changes to your fork on GitHub.\n\n ```zsh\n git push origin feature/your-feature-name\n ```\n\n7. **Create a Pull Request**: Go to the FluxUtils repository on GitHub and create a new pull request from your feature branch.\n\nPlease ensure your code adheres to the project's coding standards and includes appropriate documentation. We appreciate your contribution!\n\n## Testing\n\nFluxUtils uses unittest for its test suite. We encourage contributors to write tests for new features and bug fixes. The `fluxutils/tests/decorators/test1.py` provides a good example of how to structure tests.\n\n## Versioning\n\nFluxUtils follows [Semantic Versioning](https://semver.org/). The version number is structured as MAJOR.MINOR.PATCH:\n\n- MAJOR version increments denote incompatible API changes,\n- MINOR version increments add functionality in a backwards-compatible manner, and\n- PATCH version increments are for backwards-compatible bug fixes.\n\n## License\n\nFluxUtils is released under the MIT License. See the [LICENSE](LICENSE) file for more details.\n\n<!-- ## Acknowledgements\n\nWe would like to thank all the contributors who have helped to make FluxUtils better. Your time and effort are greatly appreciated. -->\n\n## Support\n\nIf you encounter any issues or have questions about using FluxUtils, please file an issue on the [GitHub issue tracker](https://github.com/DomBom16/fluxutils/issues).\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 DomBom16 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Various utilties to enhance your projects",
"version": "1.2.0.1",
"project_urls": {
"Homepage": "https://github.com/DomBom16/fluxutils"
},
"split_keywords": [
"utils",
" logger",
" log"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f9fe3937a2989e00d92ff99e8befc4b5054a5f7bb952e01280022e8e0a141365",
"md5": "24486cebf2d90ae8e48ad896452cfabb",
"sha256": "c44e72a83ba880468c6b816c1f5ee284e88add432c9560cd54c2bdb75905b545"
},
"downloads": -1,
"filename": "fluxutils-1.2.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "24486cebf2d90ae8e48ad896452cfabb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 30387,
"upload_time": "2024-08-07T05:12:38",
"upload_time_iso_8601": "2024-08-07T05:12:38.460394Z",
"url": "https://files.pythonhosted.org/packages/f9/fe/3937a2989e00d92ff99e8befc4b5054a5f7bb952e01280022e8e0a141365/fluxutils-1.2.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8484207415ddcbfe181c7ca7c67cdaf665e99e23297cfeb95ac86d627dd6f10c",
"md5": "175e88b339aaf7bfae87780afaa99905",
"sha256": "11a8501a6112124b41c12b9d9d91f670edf2baffa92eecf9b8d1c949698405b8"
},
"downloads": -1,
"filename": "fluxutils-1.2.0.1.tar.gz",
"has_sig": false,
"md5_digest": "175e88b339aaf7bfae87780afaa99905",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 27333,
"upload_time": "2024-08-07T05:12:39",
"upload_time_iso_8601": "2024-08-07T05:12:39.781555Z",
"url": "https://files.pythonhosted.org/packages/84/84/207415ddcbfe181c7ca7c67cdaf665e99e23297cfeb95ac86d627dd6f10c/fluxutils-1.2.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-07 05:12:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DomBom16",
"github_project": "fluxutils",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "fluxutils"
}
