Error tool (Formated error / Better visual / etc...)
Project description
Jarbin-ToolKit:Error v0.1.2.0
Latest development version
🟠 UNDER DEVELOPMENT 🟠 None 🟠Latest release
🟢 RELEASED 🟢 v0.1.2.0 🟢Description
jarbin-toolkit:error is a Python library designed to help you create enhanced terminal interfaces. It's improving the appearance and readability of your command-line interface with lightweight animations, colorful text, and neat formatting. If you want to make your terminal programs more readable and visually structured, this library is for you!
Table of Contents
- Description
- Features
- Tech Stack
- Installation
- Usage
- Project Structure
- API Reference
- Release Notes
- License
- Important Links
- Footer
Features
- Error Handling: Provides structured and readable error messages.
Tech-Stack
- Language: Python - Chosen for its readability and versatility.
- Frameworks: Python - Entirely implemented in Python.
Installation
To begin , install jarbin-toolkit:error:
Prerequisites:
Make sure you have Python 3.11 or newer installed on your computer.
You can check your Python version by opening a terminal and typing python --version.
Install from PyPI (recommended):
Open your terminal and run this command:
pip install jarbin_toolkit_error
This will automatically download and install the library from PyPI.
Install from GitHub:
If you want the latest version directly from the source, you can install it using git:
git clone -b latest NONE
make -C lib/jarbin_toolkit_error install
This downloads the code, then the install script handles the installation.
These commands install the jarbin-toolkit:error package and its dependencies (datetime).
Usage
Here are some examples demonstrating how to use jarbin-toolkit:error:
Basic Error
from jarbin_toolkit_error import Error
API-Reference
- Error: Base exception class with formatted terminal output and optional file/line linking.
-
Error(message: str = "an error occurred", *, error: str = "Error", link: tuple[str, int | None] | None = None)Create a custom error.message: detailed error messageerror: error type/titlelink: optional(file, line)reference to indicate origin
Automatically:
- Builds a formatted error link (if provided)
- Calls internal logging system (if enabled)
-
create_link() -> NoneBuild human-readable file/line reference string. -
log() -> NoneLog the error (implementation depends on global settings). -
lauch_error() -> str(staticmethod) Return formatted launch failure message (used when toolkit fails to initialize). -
__str__() -> strReturn ANSI-formatted multi-line error message ready for terminal display. -
__repr__() -> strReturn constructor-style representation of the Error object.
-
Specialized Error Types
All subclasses inherit from Error and predefine their error type.
- ErrorLaunch
ErrorLaunch(message: str = "an error occurred during the launch", *, link: tuple[str, int | None] | None = None)Raised when a launch/initialization error occurs.
- ErrorImport
ErrorImport(message: str = "an error occurred during an import", *, link: tuple[str, int | None] | None = None)Raised when an import-related error occurs.
- ErrorLog
ErrorLog(message: str = "an error occurred on/in a log file", *, link: tuple[str, int | None] | None = None)Raised for logging system failures. Overrideslog()to prevent recursive logging.
- ErrorConfig
ErrorConfig(message: str = "an error occurred on/in a config file", *, link: tuple[str, int | None] | None = None)Raised for configuration file errors.
- ErrorSetting
ErrorSetting(message: str = "an error occurred during setting's update", *, link: tuple[str, int | None] | None = None)Raised when settings update fails.
- ErrorType
ErrorType(message: str = "an error occurred on a type", *, link: tuple[str, int | None] | None = None)Raised for type-related errors.
- ErrorValue
ErrorValue(message: str = "an error occurred on a value", *, link: tuple[str, int | None] | None = None)Raised for invalid value errors.
Release-Notes
-
v0.1.1:
- [/] 1rst real release
-
v0.1.0:
- [UPDATE]
jarbin_toolkit_errorupdate (removed unlinked sub-modules) - [INIT] add
epitech_consoleto jarbin-toolkit (renamedjarbin_toolkit_error)
- [UPDATE]
License
This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.
Important-Links
Files
- Repository: https://github.com/Jarjarbin06/jarbin-toolkit
- PyPI: https://pypi.org/project/jarbin-toolkit-error/
Wiki
- Wiki (take a look): https://github.com/Jarjarbin06/jarbin-toolkit/wiki
- README (updated): https://github.com/Jarjarbin06/jarbin-toolkit/blob/main/lib/error/README.md
- GitHub: https://jarjarbin06.github.io/jarbin-toolkit/
Footer
- Repository: https://github.com/Jarjarbin06/jarbin-toolkit
- Author: Nathan Jarjarbin
- Contact: nathan.amaraggi@epitech.eu
⭐️ Like the project? Give it a star!
🐛 Found a bug? Report it in the issues!
last update :
PACKAGE = 2026/02/12 ;
README = 2026/02/12
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file jarbin_toolkit_error-0.1.2.0.tar.gz.
File metadata
- Download URL: jarbin_toolkit_error-0.1.2.0.tar.gz
- Upload date:
- Size: 32.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
83252c8b872bc8c95b56cde72f38e96ea1166fef88cbcd2188c507cfdf8eb796
|
|
| MD5 |
42cd69017c490d68c4972bef0992c31a
|
|
| BLAKE2b-256 |
3695346acabab8f82d362da463e070ce19cad0dde6aa12af823ca7e22738b560
|
File details
Details for the file jarbin_toolkit_error-0.1.2.0-py3-none-any.whl.
File metadata
- Download URL: jarbin_toolkit_error-0.1.2.0-py3-none-any.whl
- Upload date:
- Size: 18.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f55dd915d4e2e2657925ffb010a447c56c20d564600e4444f51d52f74a309534
|
|
| MD5 |
63cda3b06184c3a17a2a8132c313d8f5
|
|
| BLAKE2b-256 |
5729c1afb977c3c1b5fc3c49d597aece41464dd5e081761bab46fe49ce1ebc59
|