Skip to main content

Error tool (Formated error / Better visual / etc...)

Project description

error loading Epitech Logo error loading Jarbin-ToolKit Logo

Jarbin-ToolKit:Error v0.1.2.0

Latest development version 🟠 UNDER DEVELOPMENT 🟠 None 🟠
Latest release 🟢 RELEASED 🟢 v0.1.2.0 🟢

CodeQL Advanced Python package tester pages-build-deployment

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

  1. Description
  2. Features
  3. Tech Stack
  4. Installation
  5. Usage
  6. Project Structure
  7. API Reference
  8. Release Notes
  9. License
  10. Important Links
  11. 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 message
      • error: error type/title
      • link: optional (file, line) reference to indicate origin

      Automatically:

      • Builds a formatted error link (if provided)
      • Calls internal logging system (if enabled)
    • create_link() -> None Build human-readable file/line reference string.

    • log() -> None Log the error (implementation depends on global settings).

    • lauch_error() -> str (staticmethod) Return formatted launch failure message (used when toolkit fails to initialize).

    • __str__() -> str Return ANSI-formatted multi-line error message ready for terminal display.

    • __repr__() -> str Return 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. Overrides log() 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_error update (removed unlinked sub-modules)
    • [INIT] add epitech_console to jarbin-toolkit (renamed jarbin_toolkit_error)

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

Important-Links

Files

Wiki

Footer

⭐️ 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jarbin_toolkit_error-0.1.2.0.tar.gz (32.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jarbin_toolkit_error-0.1.2.0-py3-none-any.whl (18.4 kB view details)

Uploaded Python 3

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

Hashes for jarbin_toolkit_error-0.1.2.0.tar.gz
Algorithm Hash digest
SHA256 83252c8b872bc8c95b56cde72f38e96ea1166fef88cbcd2188c507cfdf8eb796
MD5 42cd69017c490d68c4972bef0992c31a
BLAKE2b-256 3695346acabab8f82d362da463e070ce19cad0dde6aa12af823ca7e22738b560

See more details on using hashes here.

File details

Details for the file jarbin_toolkit_error-0.1.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for jarbin_toolkit_error-0.1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f55dd915d4e2e2657925ffb010a447c56c20d564600e4444f51d52f74a309534
MD5 63cda3b06184c3a17a2a8132c313d8f5
BLAKE2b-256 5729c1afb977c3c1b5fc3c49d597aece41464dd5e081761bab46fe49ce1ebc59

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page