chronix 2.0.0.4

A small timer utility that has all the helpful features you could ever want!

chronix

chronix is every concept timer you've ever seen, rolled into one. It has all the helpful features you could ever want.

Compatibility

🟩 (Works perfectly); 🟨 (Untested); 🟧 (Some Issues); 🟥 (Unusable)

OS
Windows	🟩
MacOS	🟩
Linux (Ubuntu 22.04 LTS)	🟩

Features

• Easy to use for beginners, but not lacking for experts
• Efficient
• Fully cross-platform
• Regular updates and support
• Comprehensive documentation

Installation

You can install chronix via pip:

pip install chronix --pre --upgrade

Or clone the repository and install manually:

git clone https://github.com/Adalfarus/chronix.git
cd chronix
python -m pip install .

If you have problems with the package please use py -m pip install chronix[cli,dev] --pre --upgrade --user

📦 Usage

Here are a few quick examples of how to use chronix.

---

⏱ Basic Timing (chronix)

Measure elapsed time with nanosecond resolution.

---

⏲ Use BasicTimer for simple measurements

from chronix import BasicTimer
import time

timer = BasicTimer(auto_start=True)
time.sleep(0.123)
timer.stop()

print(timer.get())          # timedelta
print(timer.get_readable()) # Human-readable

---

📏 Create precise deltas

from chronix import PreciseTimeDelta

delta = PreciseTimeDelta(seconds=1.5, microseconds=250)
print(str(delta))           # 0:00:01.500250
print(delta.to_readable())  # "1.500s"

---

⏱ Flexible Timing with FlexTimer

Advanced control for performance tracking, interval measurements, and benchmarking.

---

🧪 Measure CPU-only time (ignores sleep)

from chronix import CPUFTimer

with CPUFTimer():
    sum(i * i for i in range(100_000))

Ideal for benchmarking with minimal system interference.

---

🔄 Manual start/stop and waiting

from chronix import FlexTimer

t = FlexTimer(start_now=False)
t.start(start_at=1.2)
t.wait(0.8)
t.stop()

print(t.get().to_clock_string())  # e.g., 00:00:02.00

---

⏱ Record laps (interval checkpoints)

t = FlexTimer()
# ... task 1 ...
t.lap()
# ... task 2 ...
t.lap()

print(t.show_laps())  # List of lap durations

---

🪄 Time entire functions with a decorator

@FlexTimer().time()
def compute():
    return [x**2 for x in range(1_000_000)]

compute()  # Prints execution time

---

🕒 Schedule callbacks after a delay

def on_done():
    print("Finished!")

FlexTimer().after(2, on_done)

---

🧵 Run functions at intervals

def tick():
    print("Tick!")

FlexTimer().interval(1, count=5, callback=tick)

---

📈 Estimate time complexity of a function

def fn(n):
    return [i ** 2 for i in range(n)]

def gen_inputs():
    for i in range(1000, 50000, 1000):
        yield ((i,), {})

from chronix import FlexTimer
print(FlexTimer.complexity(fn, gen_inputs()))  # e.g., "O(N)"

chrono cli

Can currently run tests with chrono tests run tests/ -minimal and show a basic help using chrono help.

For more detailed usage and examples, check out our documentation.

Naming convention, dependencies and library information

PEP 8 -- Style Guide for Python Code

For modules I use 'lowercase', classes are 'CapitalizedWords' and functions and methods are 'lower_case_with_underscores'.

Contributing

We welcome contributions! Please see our contributing guidelines for more details on how you can contribute to chronix.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a pull request

Aps Build master

You can use the aps_build_master script for your os to make your like a lot easier. It supports running tests, installing, building and much more as well as chaining together as many commands as you like.

This example runs test, build the project and then installs it

call .\aps_build_master.bat 234

sudo apt install python3-pip
sudo apt install python3-venv
chmod +x ./aps_build_master.sh
./aps_build_master.sh 234

License

chronix is licensed under the LGPL-3.0 License - see the LICENSE file for details.