Skip to main content

Config tool (Create / Set / Read / etc...)

Project description

error loading Epitech Logo error loading Jarbin-ToolKit Logo

Jarbin-ToolKit:Config 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:config 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:config:

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_config

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

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

Usage

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

Basic Config

from jarbin_toolkit_config import Config

API-Reference

  • Config: INI configuration file manager built on configparser.
    • Config(path: str, data: dict | None = None, *, file_name: str = "config.ini") Create a new config file if it does not exist, otherwise read it.
      • path: directory where the config file is located
      • data: optional dictionary used to initialize file content (section → key/value pairs)
      • file_name: name of the configuration file (default: config.ini)
      • Automatically adapts path separators depending on OS (Windows/Linux)
    • set(section: str, option: str, data: Any) -> None Set or update a value in the config file.
      • section: section name
      • option: key name
      • data: value to store (converted to string)
      • Immediately writes changes to disk
    • get(section: str, option: str, wanted_type: type = str) -> Any Retrieve a value from the config file.
      • section: section name
      • option: key name
      • wanted_type: type conversion applied to the result (default: str)
      • Returns the converted value
    • get_bool(section: str, option: str) -> bool Retrieve a value as boolean.
    • get_int(section: str, option: str) -> int Retrieve a value as integer.
    • get_float(section: str, option: str) -> float Retrieve a value as float.
    • delete(cached: bool = False) -> bool Delete the config file from disk.
      • cached: if True, keeps config data in memory
      • Returns True if successfully deleted, False otherwise
    • exist(path: str, *, file_name: str = "config.ini") -> bool (staticmethod) Check whether a config file exists and is not empty.
      • path: directory path
      • file_name: name of config file
      • Returns True if file exists and contains data, False otherwise
    • __repr__() -> str Return constructor-style representation of the Config object.

Release-Notes

  • v0.1.1:

    • [/] 1rst real release
  • v0.1.0:

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

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/01/21 ; 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_config-0.1.2.0.tar.gz (29.3 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_config-0.1.2.0-py3-none-any.whl (18.2 kB view details)

Uploaded Python 3

File details

Details for the file jarbin_toolkit_config-0.1.2.0.tar.gz.

File metadata

  • Download URL: jarbin_toolkit_config-0.1.2.0.tar.gz
  • Upload date:
  • Size: 29.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for jarbin_toolkit_config-0.1.2.0.tar.gz
Algorithm Hash digest
SHA256 3785068d5718baa758a894d698a56551c9b9c16107bebe1a02556e1c613969a8
MD5 b6fa7e0ec1785b6b03f657d29b412c34
BLAKE2b-256 4a35397695fcb3c74610817104eb54fa0cf5f0b5002e8a518960863061304c71

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for jarbin_toolkit_config-0.1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2565392a90994b9e6b4fa5820c5f3973738d7caaaab8eead9a2a1b5d19b749d5
MD5 d63549b359c8a2eb97f036f08f0649c8
BLAKE2b-256 dbf0ac76ad9e73b6ccdc202e7a6f55b846c04f7f5b5e7b03e0285792ae11acae

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