# Notiblocks
<img src="https://img.shields.io/pypi/dm/notiblocks?style=for-the-badge&logo=python&logoColor=blue&label=notiblocks&labelColor=white&color=green&link=https%3A%2F%2Fpypi.org%2Fproject%2Fnotiblocks%2F"/>
<img src="docs/pics/usage_example.png" />
*Quick and easy customizable terminal logs for your python application.*
<br />
> Find, support and contribute to the project's source code [`here`](https://github.com/notiblocks/notiblocks)
## Table of Contents
- [`Introduction`](#introduction)
- [`Features`](#features)
- [`Installation`](#installation)
- [`Usage`](#usage)
- [`Contributing`](#contributing)
- [`License`](#license)
## Introduction
Welcome to Notiblocks, a versatile Python library designed to enhance terminal logging with customizable and intuitive features.
### Documentation
If you want to **learn** how to use `notiblocks`, check the [`documentation`](https://app.gitbook.com/o/4FBvhI5UXLbq0HL9OCTS/s/z6b70RGC8WhxZqoCAV0k/)
### What is Notiblocks?
Notiblocks is more than just a logging library; it's a powerful tool that simplifies and elevates your terminal logging experience. It offers a user-friendly interface for creating custom, eye-catching logs, allowing developers to seamlessly integrate informative and visually appealing messages into their applications.
### Why Notiblocks?
- **Simplicity**: With Notiblocks, logging becomes effortless. Its intuitive design makes it easy to craft customized terminal logs without complex configurations.
- **Customization**: Tailor your logs to suit your application's needs. Notiblocks offers a wide range of styling options, allowing you to create logs that stand out.
- **Versatility**: Whether you're working on a small script or a large-scale project, Notiblocks scales to meet your logging requirements.
## Features
- Customizable log styles and colors
- Easy integration into existing projects
- Make your own logging templates and reuse them whenever you want to
- Inline formatting, so you could add anything you want in the logs
- Low resource usage
## Installation
Install notiblocks trough pip
```bash
pip install notiblocks
```
And just import the module into your application
```python
import notiblocks
```
## Usage
Notiblocks uses `NBConfig` and `NBHandler` objects, which let you customize your logs by your needs. You can access them trough the module.
* **`NBConfig`**: Holds the information about how your logs will look. You can override the information trough the constructor, or through the setters. For further explanation check the [`docs`](/docs/documented/nbconfig.md).
* **NBHandler**: Wrapper class for the `NBConfig`, which provides the main functionalities as `success`, `fail`, `warn` and `log`. For further information check the [`docs`](/docs/documented/nbhandler.md).
* **ILFormatter**: Let's you create custom inline formatting using the `$` sign and providing the configuration as a list. For more brief look, check the [`docs`](/docs/documented/ilformatter.md)
Example:
```python
from notiblocks import NBConfig, NBHandler
from notiblocks import ILFormatter
nb_conf = NBConfig(
success_sign_color="blue",
time_sign_color="GrEEn",
success_sign="SUCCESS",
success_bracket_color="cyan",
time_sign_stamp="DATE",
bracket_style="round ",
warn_bracket_sign="square"
)
nb_handler = NBHandler(nb_conf)
print(nb_handler.success(ILFormatter.format("This is a $TEST$ successful message", ["red"])))
print(nb_handler.fail("Notiblocks is still not in a finished state..."))
print(nb_handler.warn("You haven't smiled enough today :)"))
print(nb_handler.log(f"User {page.user} accessed this page"))
```
## Contributing
The notiblocks team would be more than happy to see your code suggestions. If you want to help out in some way - you could!
* **We wellcome feature ideas!** - If you want to see something in the project, that **you** think would be usable and would make your life easier, open a discussion, issue or even implement it! Before commiting, though, check the [`contribution guidelines`](/CONTRIBUTING.md) :)
## License
Notiblocks is licensed under the MIT License, check [`LICENSE`](/LICENSE) for more information.
### Join us on the journey to transform your terminal logging experience with Notiblocks!
Raw data
{
"_id": null,
"home_page": "",
"name": "notiblocks",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,logging,warning,terminal,ansi,color",
"author": "D4rkC47 (Deyan Sirakov)",
"author_email": "dvs_sec@proton.me",
"download_url": "https://files.pythonhosted.org/packages/65/d5/e84c94bbae669c3b4a594d9d8132660969eae66de362b7c5a63db35413db/notiblocks-0.0.3.tar.gz",
"platform": null,
"description": "# Notiblocks\n<img src=\"https://img.shields.io/pypi/dm/notiblocks?style=for-the-badge&logo=python&logoColor=blue&label=notiblocks&labelColor=white&color=green&link=https%3A%2F%2Fpypi.org%2Fproject%2Fnotiblocks%2F\"/>\n\n<img src=\"docs/pics/usage_example.png\" />\n\n*Quick and easy customizable terminal logs for your python application.*\n<br />\n> Find, support and contribute to the project's source code [`here`](https://github.com/notiblocks/notiblocks) \n\n## Table of Contents\n\n- [`Introduction`](#introduction)\n- [`Features`](#features)\n- [`Installation`](#installation)\n- [`Usage`](#usage)\n- [`Contributing`](#contributing)\n- [`License`](#license)\n\n## Introduction\n\nWelcome to Notiblocks, a versatile Python library designed to enhance terminal logging with customizable and intuitive features.\n\n\n### Documentation\nIf you want to **learn** how to use `notiblocks`, check the [`documentation`](https://app.gitbook.com/o/4FBvhI5UXLbq0HL9OCTS/s/z6b70RGC8WhxZqoCAV0k/)\n### What is Notiblocks?\n\nNotiblocks is more than just a logging library; it's a powerful tool that simplifies and elevates your terminal logging experience. It offers a user-friendly interface for creating custom, eye-catching logs, allowing developers to seamlessly integrate informative and visually appealing messages into their applications.\n\n### Why Notiblocks?\n\n- **Simplicity**: With Notiblocks, logging becomes effortless. Its intuitive design makes it easy to craft customized terminal logs without complex configurations.\n \n- **Customization**: Tailor your logs to suit your application's needs. Notiblocks offers a wide range of styling options, allowing you to create logs that stand out.\n\n- **Versatility**: Whether you're working on a small script or a large-scale project, Notiblocks scales to meet your logging requirements.\n\n## Features\n\n- Customizable log styles and colors\n- Easy integration into existing projects\n- Make your own logging templates and reuse them whenever you want to\n- Inline formatting, so you could add anything you want in the logs\n- Low resource usage\n\n## Installation\n\nInstall notiblocks trough pip\n\n```bash\npip install notiblocks\n```\n\nAnd just import the module into your application\n\n```python\nimport notiblocks\n```\n\n## Usage\nNotiblocks uses `NBConfig` and `NBHandler` objects, which let you customize your logs by your needs. You can access them trough the module.\n\n* **`NBConfig`**: Holds the information about how your logs will look. You can override the information trough the constructor, or through the setters. For further explanation check the [`docs`](/docs/documented/nbconfig.md).\n* **NBHandler**: Wrapper class for the `NBConfig`, which provides the main functionalities as `success`, `fail`, `warn` and `log`. For further information check the [`docs`](/docs/documented/nbhandler.md).\n* **ILFormatter**: Let's you create custom inline formatting using the `$` sign and providing the configuration as a list. For more brief look, check the [`docs`](/docs/documented/ilformatter.md)\n\nExample:\n```python\nfrom notiblocks import NBConfig, NBHandler\nfrom notiblocks import ILFormatter\n\nnb_conf = NBConfig(\n success_sign_color=\"blue\",\n time_sign_color=\"GrEEn\",\n success_sign=\"SUCCESS\",\n success_bracket_color=\"cyan\",\n time_sign_stamp=\"DATE\",\n bracket_style=\"round \",\n warn_bracket_sign=\"square\"\n)\n\nnb_handler = NBHandler(nb_conf)\n\nprint(nb_handler.success(ILFormatter.format(\"This is a $TEST$ successful message\", [\"red\"])))\n\nprint(nb_handler.fail(\"Notiblocks is still not in a finished state...\"))\nprint(nb_handler.warn(\"You haven't smiled enough today :)\"))\nprint(nb_handler.log(f\"User {page.user} accessed this page\"))\n```\n\n## Contributing\nThe notiblocks team would be more than happy to see your code suggestions. If you want to help out in some way - you could!\n* **We wellcome feature ideas!** - If you want to see something in the project, that **you** think would be usable and would make your life easier, open a discussion, issue or even implement it! Before commiting, though, check the [`contribution guidelines`](/CONTRIBUTING.md) :)\n\n## License\nNotiblocks is licensed under the MIT License, check [`LICENSE`](/LICENSE) for more information.\n\n### Join us on the journey to transform your terminal logging experience with Notiblocks!\n",
"bugtrack_url": null,
"license": "",
"summary": "Logging library for the impatient",
"version": "0.0.3",
"project_urls": null,
"split_keywords": [
"python",
"logging",
"warning",
"terminal",
"ansi",
"color"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "816eb3726781bde76e85a8017612ff973964c133173720f03c63ba93ac1193fb",
"md5": "680cd02db04309f0ff896d3b648a7881",
"sha256": "e55b84df2175e98505a665d523a49b7875eb7486d5356ded1b87c92d9197ac43"
},
"downloads": -1,
"filename": "notiblocks-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "680cd02db04309f0ff896d3b648a7881",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4508,
"upload_time": "2024-03-01T19:31:59",
"upload_time_iso_8601": "2024-03-01T19:31:59.238008Z",
"url": "https://files.pythonhosted.org/packages/81/6e/b3726781bde76e85a8017612ff973964c133173720f03c63ba93ac1193fb/notiblocks-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "65d5e84c94bbae669c3b4a594d9d8132660969eae66de362b7c5a63db35413db",
"md5": "497a8899b6d53aefd2dabd01c360cc10",
"sha256": "3b981219ccedf97e44971b576a5ca2e5cef10a81c149a0e95ce49ee72a9315bb"
},
"downloads": -1,
"filename": "notiblocks-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "497a8899b6d53aefd2dabd01c360cc10",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4185,
"upload_time": "2024-03-01T19:32:00",
"upload_time_iso_8601": "2024-03-01T19:32:00.908209Z",
"url": "https://files.pythonhosted.org/packages/65/d5/e84c94bbae669c3b4a594d9d8132660969eae66de362b7c5a63db35413db/notiblocks-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-01 19:32:00",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "notiblocks"
}
JSON