<p align="center">
<img alt="Language: Python" src="https://img.shields.io/badge/Language-Python-purple?style=flat-square">
<img alt="Version: 1.0.0" src="https://img.shields.io/badge/Version-Beta_1.0-green?style=flat-square">
<img alt="Devlopment Stage: Early Beta" src="https://img.shields.io/badge/Development_Stage-Early_Beta-orange?style=flat-square">
<img alt="License: LGPLv3" src="https://img.shields.io/badge/License-LGPLv3-blue?style=flat-square">
<img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow?style=flat-square"><br>
Cerbose is a simple, cross-platform Python library, mainly for making tagged, colourful console output along with additional features.<br>
<a href="https://jasperredis.github.io/cerbose">Website</a> |
<a href="https://pypi.org/project/cerbose">PyPI</a> |
<a href="https://jris.straw.page">jasperredis</a><br>
Made by jasperredis [o]:
<br><br>
It is highly reccomended to check <a href="https://jasperredis.github.io/cerbose">the website. This contains documentation.</a>
</p>
---
> This wasn't done in a codeblock because they can't display colours.
# Functions
## cprint
This is the highlight function of Cerbose. It outputs highly configurable tagged text to the console, and you can configure the following:
- Tag (obviously)
- Text (obviously)
- Logging (enabled, file, and optional feedback)
- Text colour
- Dual tags
- Timestamp (enabled?)
- And more through configuration files.
It also has a "valonly" mode where it returns the suppposed output instead of printing it.
More info in the documentation.
## mprint
The same as cprint, except it has multiline support.
## cerbar
Returns an ASCII progress bar. You can configure the following:
- Length in characters
- Value being represented (obviously) in regular integers, not percentages.
- Optionally add the percentage represented be before/after the progress bar.
- Optionally add the amount represented (fill/total) before/after the progress bar.
- And more through configuration files.
More info in the documentation.
## cin
Takes user input and returns the input. You can configure the following:
- Prompt (obviously)
- All options for `cprint` in the prompt.
- 'i' and 'o' mode. 'i' allows any text input (remember to set options to 'any'!), and 'o' has a strict set of options.
- Recieving user input as lowercase (enabled?)
More info in docs.
# Configuration
Cerbose can be more highly configured via config files. As always, the documentation has the best information on this, but here is roughly what you can configure with these:
- Tag colours
- Tag text
- Symbols (brackets, cerbar contents, etc.)
- Timestamp format
- Space repeat tolerance (check documentation)
Cerbose config files are in JSON format.
# Licensing
Always, for more information related to licenses in Cerbose, check the [LICENSE](LICENSE) file in the project root and the files it refers to.
- Cerbose, the Python script itself, is licensed under the GNU Lesser General Public License v3.0 or later. What constitutes as the script itself is any file in the src/ directory of this repository.
+ See the [LICENSE-LGPL](LICENSE-LGPL) file for more info.
+ The LGPLv3 is an extension of the GNU General Public License v3. See the [LICENSE-GPL](LICENSE-GPL) file for more info.
- All other files, with reasonable exception of license-related files (e.g., docs, examples) are under the MIT License.
+ See the [LICENSE-MIT](LICENSE-MIT) file for more info.
**REMINDER**: The best source of information in Cerbose (and most other projects you will encounter) is the [LICENSE](LICENSE) file at the project root.
<h2 align="center">
Primarily made by:<br><br>
<img alt="jasperredis" src="readme/jrisbanner.png">
</h2>
Raw data
{
"_id": null,
"home_page": null,
"name": "cerbose",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "terminal, colors, progress bar, console",
"author": "jasperredis",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/d9/9d/c1d565d97d9fd76f53d67721d238b5f05665be42a7532315057cee505d82/cerbose-1.0.0.post1.tar.gz",
"platform": null,
"description": "\n<p align=\"center\">\n <img alt=\"Language: Python\" src=\"https://img.shields.io/badge/Language-Python-purple?style=flat-square\">\n <img alt=\"Version: 1.0.0\" src=\"https://img.shields.io/badge/Version-Beta_1.0-green?style=flat-square\">\n <img alt=\"Devlopment Stage: Early Beta\" src=\"https://img.shields.io/badge/Development_Stage-Early_Beta-orange?style=flat-square\">\n <img alt=\"License: LGPLv3\" src=\"https://img.shields.io/badge/License-LGPLv3-blue?style=flat-square\">\n <img alt=\"License: MIT\" src=\"https://img.shields.io/badge/License-MIT-yellow?style=flat-square\"><br>\n Cerbose is a simple, cross-platform Python library, mainly for making tagged, colourful console output along with additional features.<br>\n <a href=\"https://jasperredis.github.io/cerbose\">Website</a> |\n <a href=\"https://pypi.org/project/cerbose\">PyPI</a> |\n <a href=\"https://jris.straw.page\">jasperredis</a><br>\n Made by jasperredis [o]:\n <br><br>\n It is highly reccomended to check <a href=\"https://jasperredis.github.io/cerbose\">the website. This contains documentation.</a>\n</p>\n\n---\n\n> This wasn't done in a codeblock because they can't display colours.\n\n# Functions\n## cprint\nThis is the highlight function of Cerbose. It outputs highly configurable tagged text to the console, and you can configure the following:\n- Tag (obviously)\n- Text (obviously)\n- Logging (enabled, file, and optional feedback)\n- Text colour\n- Dual tags\n- Timestamp (enabled?)\n- And more through configuration files. \n\nIt also has a \"valonly\" mode where it returns the suppposed output instead of printing it. \nMore info in the documentation.\n\n## mprint\nThe same as cprint, except it has multiline support.\n\n## cerbar\nReturns an ASCII progress bar. You can configure the following:\n- Length in characters\n- Value being represented (obviously) in regular integers, not percentages.\n- Optionally add the percentage represented be before/after the progress bar.\n- Optionally add the amount represented (fill/total) before/after the progress bar.\n- And more through configuration files. \n\nMore info in the documentation.\n\n## cin\nTakes user input and returns the input. You can configure the following:\n- Prompt (obviously)\n- All options for `cprint` in the prompt.\n- 'i' and 'o' mode. 'i' allows any text input (remember to set options to 'any'!), and 'o' has a strict set of options.\n- Recieving user input as lowercase (enabled?)\n\nMore info in docs.\n\n# Configuration\nCerbose can be more highly configured via config files. As always, the documentation has the best information on this, but here is roughly what you can configure with these:\n- Tag colours\n- Tag text\n- Symbols (brackets, cerbar contents, etc.)\n- Timestamp format\n- Space repeat tolerance (check documentation)\n\nCerbose config files are in JSON format.\n\n# Licensing\nAlways, for more information related to licenses in Cerbose, check the [LICENSE](LICENSE) file in the project root and the files it refers to.\n\n- Cerbose, the Python script itself, is licensed under the GNU Lesser General Public License v3.0 or later. What constitutes as the script itself is any file in the src/ directory of this repository.\n + See the [LICENSE-LGPL](LICENSE-LGPL) file for more info.\n + The LGPLv3 is an extension of the GNU General Public License v3. See the [LICENSE-GPL](LICENSE-GPL) file for more info.\n- All other files, with reasonable exception of license-related files (e.g., docs, examples) are under the MIT License.\n + See the [LICENSE-MIT](LICENSE-MIT) file for more info.\n\n**REMINDER**: The best source of information in Cerbose (and most other projects you will encounter) is the [LICENSE](LICENSE) file at the project root.\n\n<h2 align=\"center\">\n Primarily made by:<br><br>\n <img alt=\"jasperredis\" src=\"readme/jrisbanner.png\">\n</h2>\n",
"bugtrack_url": null,
"license": "LGPL-3.0-or-later",
"summary": "A simple Python library for making colourful, tagged terminal output, along with additional console features.",
"version": "1.0.0.post1",
"project_urls": {
"Docs": "https://jasperredis.github.io/cerbose/docs.html",
"Homepage": "https://jasperredis.github.io/cerbose",
"PyPI": "https://pypi.org/project/cerbose/",
"Repository": "https://github.com/jasperredis/cerbose-lib",
"jasperredis": "https://jris.straw.page"
},
"split_keywords": [
"terminal",
" colors",
" progress bar",
" console"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d99dc1d565d97d9fd76f53d67721d238b5f05665be42a7532315057cee505d82",
"md5": "5c06c8a54346be74b5b20b4ab05ab0c6",
"sha256": "7997cd682d21286101950004f4734adcc33c2b84b4305b0750ed9b529310c88c"
},
"downloads": -1,
"filename": "cerbose-1.0.0.post1.tar.gz",
"has_sig": false,
"md5_digest": "5c06c8a54346be74b5b20b4ab05ab0c6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 144925,
"upload_time": "2025-07-11T02:06:26",
"upload_time_iso_8601": "2025-07-11T02:06:26.750284Z",
"url": "https://files.pythonhosted.org/packages/d9/9d/c1d565d97d9fd76f53d67721d238b5f05665be42a7532315057cee505d82/cerbose-1.0.0.post1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-11 02:06:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jasperredis",
"github_project": "cerbose-lib",
"github_not_found": true,
"lcname": "cerbose"
}
JSON
