Config tool (Create / Set / Read / etc...)
Project description
Jarbin-ToolKit:Config v0.1.2.1
Latest versions
🟠 UNDER DEVELOPMENT 🟠 None 🟠🟢 RELEASED 🟢 v0.1.2.1 🟢
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
- Description
- Features
- Tech Stack
- Installation
- Usage
- Project Structure
- API Reference
- Release Notes
- License
- Important Links
- 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 locateddata: 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) -> NoneSet or update a value in the config file.section: section nameoption: key namedata: value to store (converted to string)- Immediately writes changes to disk
get(section: str, option: str, wanted_type: type = str) -> AnyRetrieve a value from the config file.section: section nameoption: key namewanted_type: type conversion applied to the result (default:str)- Returns the converted value
get_bool(section: str, option: str) -> boolRetrieve a value as boolean.get_int(section: str, option: str) -> intRetrieve a value as integer.get_float(section: str, option: str) -> floatRetrieve a value as float.delete(cached: bool = False) -> boolDelete the config file from disk.cached: ifTrue, keeps config data in memory- Returns
Trueif successfully deleted,Falseotherwise
exist(path: str, *, file_name: str = "config.ini") -> bool(staticmethod) Check whether a config file exists and is not empty.path: directory pathfile_name: name of config file- Returns
Trueif file exists and contains data,Falseotherwise
__repr__() -> strReturn constructor-style representation of the Config object.
Release-Notes
-
v0.1.1:
- [/] 1rst real release
-
v0.1.0:
- [UPDATE]
jarbin_toolkit_configupdate (removed unlinked sub-modules) - [INIT] add
epitech_consoleto jarbin-toolkit (renamedjarbin_toolkit_config)
- [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-config/
Wiki
- Wiki (take a look): https://github.com/Jarjarbin06/jarbin-toolkit/wiki
- README (updated): https://github.com/Jarjarbin06/jarbin-toolkit/blob/main/lib/config/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/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
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_config-0.1.2.1.tar.gz.
File metadata
- Download URL: jarbin_toolkit_config-0.1.2.1.tar.gz
- Upload date:
- Size: 29.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7a84e05e41ee57bface9f8ea3bde6f2d3a7c0d060e40719617276b75a0d27745
|
|
| MD5 |
792f8a9f92189022ef9a0e106bd13aa2
|
|
| BLAKE2b-256 |
976804f0518f781294979dae57eb3c98b541784c157dc239e6342b8623167576
|
File details
Details for the file jarbin_toolkit_config-0.1.2.1-py3-none-any.whl.
File metadata
- Download URL: jarbin_toolkit_config-0.1.2.1-py3-none-any.whl
- Upload date:
- Size: 18.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d7924a5fbac79a67173a1284c5e67a70b3abda7c42b43d1b1c72306605aed1da
|
|
| MD5 |
c65b70936810ad2b451fff70df3c0671
|
|
| BLAKE2b-256 |
3afdd8c9dcd7451aa999387d18d4759649c5c7a1b1b251f09e954f3eec55af21
|