jarbin-toolkit-log 0.2.1.0

Log tool (Create / Log / Read / etc...)

Jarbin-ToolKit:Log v0.2.1.0

Latest development version

🟠 UNDER DEVELOPMENT 🟠 None 🟠

Latest release

🟢 RELEASED 🟢 v0.2.1.0 🟢

Description

jarbin-toolkit:log 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

• Timers: Use the built-in stopwatch to measure how long parts of your code take to run.

Tech-Stack

• Language: Python - Chosen for its readability and versatility.
• Frameworks: Python - Entirely implemented in Python.

Installation

To begin , install jarbin-toolkit:log:

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_log

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_log install

This downloads the code, then the install script handles the installation. These commands install the jarbin-toolkit:log package and its dependencies (datetime).

Usage

Here are some examples demonstrating how to use jarbin-toolkit:log:

Basic Log

from jarbin_toolkit_log import Log

API-Reference

• Log: File logging system (custom .jar-log or JSON format).
  • Log(path: str, file_name: str | None = None, json: bool = False) Create a new log file.
    • path: directory where file will be created
    • file_name: optional file name (default = timestamp)
    • json: switch to JSON log format
  • log(status: str, title: str, description: str) Format and append a log entry.
    • status: INFO / VALID / WARN / ERROR (or custom)
    • title: short title (auto-truncated to 10 chars in jar-log)
    • description: detailed message
  • comment(comment: str) Append a comment line (jar-log only).
  • save(log_str: str) Append raw formatted log string to file.
  • close(delete: bool = False) Close the log file properly.
    • Finalizes structure (----END---- or closes JSON array)
  • delete() Delete the log file from disk.
  • read() -> str Return raw content of the log file.
  • _jar_log_str(filter: list[str] | str | None = None) -> str Return formatted and colorized jar-log output.
  • _json_str(filter: list[str] | str | None = None) -> str Return formatted JSON log output.
  • str_filtered(f: list[str] | str) -> str Return filtered formatted log.
  • __str__(filter: list[str] | str | None = None) -> str Return formatted log representation.
  • __repr__() -> str Return constructor-style representation of the Log object.

Release-Notes

• v0.2.1:

  • [/] 1rst real release

• v0.2.0:

  • [UPDATE] change log file extension to custom extension (jar-log)
  • [ADD] modification not allowed after closing or after opening and existing file
  • [UPDATE] add option to choose between .log or log.json file
    (.log for more human readability, .json for more computer readability)

• v0.1.0:

  • [UPDATE] jarbin_toolkit_log update (removed unlinked sub-modules)
  • [INIT] add epitech_console to jarbin-toolkit (renamed jarbin_toolkit_log)

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-log/

Wiki

• Wiki (take a look): https://github.com/Jarjarbin06/jarbin-toolkit/wiki
• README (updated): https://github.com/Jarjarbin06/jarbin-toolkit/blob/main/lib/log/README.md
• GitHub: https://jarjarbin06.github.io/jarbin-toolkit/

Footer

• Repository: https://github.com/Jarjarbin06/jarbin-toolkit
• Author: Nathan Jarjarbin
• Contact: [e-mail]

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