Time tool (Stop-Watch / Sleep / Pause / etc...)
Project description
Jarbin-ToolKit:Time v0.1.2.0
Latest development version
🟠 UNDER DEVELOPMENT 🟠 None 🟠Latest release
🟢 RELEASED 🟢 v0.1.2.0 🟢Description
jarbin-toolkit:time 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:time:
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_time
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_time install
This downloads the code, then the install script handles the installation.
These commands install the jarbin-toolkit:time package and its dependencies (datetime).
Usage
Here are some examples demonstrating how to use jarbin-toolkit:time:
Basic Error
from jarbin_toolkit_time import Time, StopWatch
API-Reference
-
Time: Static time utility helpers (waiting, pausing, precise elapsed measurement).
-
wait(sleep: int | float) -> float(staticmethod) Wait for a given number of seconds.sleep: duration in seconds- Uses internal
StopWatch - Returns the exact measured elapsed time
-
pause(msg: str = "Press enter to continue...") -> float(staticmethod) Pause program execution until user presses Enter.msg: message displayed to the user- Returns the exact elapsed pause time
-
-
StopWatch: Lightweight elapsed time tracker.
-
StopWatch(start: bool = False)Create a stopwatch.start: ifTrue, automatically start at initialization
-
start() -> NoneReset and start the stopwatch. -
stop() -> NoneStop the stopwatch (freezes elapsed value). -
update() -> NoneUpdate internal elapsed time (if running). -
elapsed(auto_update: bool = True) -> floatReturn elapsed time in seconds.auto_update: automatically refresh before returning value
-
reset() -> NoneReset elapsed time and stop the stopwatch. -
__str__() -> strReturn string representation of elapsed time. -
__repr__() -> strReturn constructor-style representation of the StopWatch object. -
__eq__(other: float) -> boolCompare elapsed time with float (==). -
__gt__(other: float) -> boolCompare elapsed time with float (>). -
__ge__(other: float) -> boolCompare elapsed time with float (>=). -
__lt__(other: float) -> boolCompare elapsed time with float (<). -
__le__(other: float) -> boolCompare elapsed time with float (<=).
-
Release-Notes
-
v0.1.1:
- [/] 1rst real release
-
v0.1.0:
- [UPDATE]
jarbin_toolkit_timeupdate (removed unlinked sub-modules) - [INIT] add
epitech_consoleto jarbin-toolkit (renamedjarbin_toolkit_time)
- [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-time/
Wiki
- Wiki (take a look): https://github.com/Jarjarbin06/jarbin-toolkit/wiki
- README (updated): https://github.com/Jarjarbin06/jarbin-toolkit/blob/main/lib/time/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_time-0.1.2.0.tar.gz.
File metadata
- Download URL: jarbin_toolkit_time-0.1.2.0.tar.gz
- Upload date:
- Size: 29.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0a9be45631633c05d23e26963d8d044622aa6fc4145abca58d4539adb8303cdd
|
|
| MD5 |
317b6c4dae67e865083a6faf75d5ada4
|
|
| BLAKE2b-256 |
e968ee2f1a45a1691f76bffda1d6c7dba07918dcd7101fa603acf4083f690f0c
|
File details
Details for the file jarbin_toolkit_time-0.1.2.0-py3-none-any.whl.
File metadata
- Download URL: jarbin_toolkit_time-0.1.2.0-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.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
67fe1db97c39463bb1c6210d42c9a0155e3831279946b81f73679841c0bf1500
|
|
| MD5 |
ff1a08ec00d5a808cd7c5391eea410b6
|
|
| BLAKE2b-256 |
1ea23292b197256e31fa4471a2dd5a0fc85e407334fe5af8243769c41dbe2358
|