Skip to main content

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

Project description

last update : PACKAGE = 2026/02/05 ; README = 2026/02/05

error loading Epitech Logo error loading Jarbin-ToolKit:Log Logo

Jarbin-ToolKit:Log v0.2.0.0

Latest development version 🟠 UNDER DEVELOPMENT 🟠 v0.2.0.0 🟠
Latest release 🟢 RELEASED 🟢 v0.1.0.0 🟢

Python package License: GPL v3 Stars

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

. = function ; + = class constructor ; _ = class method ; @ = static method ; # = class variable

Error Module

  • Error: Class for custom error handling.
    • +Error(message: str = "an error occurred", error: str = "Error", link: tuple[str, int] | None = None): Constructor to create an error object.

Release-Notes

  • 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 NONE file for details.

Important-Links

Files

Wiki

Footer

⭐️ Like the project? Give it a star! 🐛 Found a bug? Report it in the issues!

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_log-0.2.0.0.tar.gz (29.1 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_log-0.2.0.0-py3-none-any.whl (18.3 kB view details)

Uploaded Python 3

File details

Details for the file jarbin_toolkit_log-0.2.0.0.tar.gz.

File metadata

  • Download URL: jarbin_toolkit_log-0.2.0.0.tar.gz
  • Upload date:
  • Size: 29.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.11

File hashes

Hashes for jarbin_toolkit_log-0.2.0.0.tar.gz
Algorithm Hash digest
SHA256 ec730ecbf58dc4259310f5268dc3bb1939e7a4f88dc998381ef9a23e8f0aaf0a
MD5 2431ca2912823f536755b030d5502e78
BLAKE2b-256 5a58f8763a043fb370ed6cace9238c599327d8f175d34168f88fb29b88faed19

See more details on using hashes here.

File details

Details for the file jarbin_toolkit_log-0.2.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for jarbin_toolkit_log-0.2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6a487a19ce6b92ccbbbea6ffd8ef670cb91f8f824be36126d9a0b1edcf66d6d5
MD5 40bfbcb840fe6e2f83074f651178f06d
BLAKE2b-256 960cdb44c3813f3303b230a593127613890ed430f85db578d308413378138ca9

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