A Python library for trading calendar management, execution profiling, and temporal backtesting (Time Travel).
Project description
Chronosx Quant
A Python library for trading calendar management, execution profiling, and temporal backtesting (Time Travel).
Installation
Install the library:
uv build
pip install dist/chronosx_quant-0.2.2-py3-none-any.whl
# install from pypi
pip install chronosx-quant
# check holidays in the next month
uv run chronosx-preview
chronosx-preview
Install the extra dependencies for the HTTP service:
uv sync --group docker
Install the default development dependencies for tests and benchmarks:
uv sync
Usage
from chronosx_quant.time import ChronoTime
import pandas as pd
# use CALENDAR_NAME to select default calendar, e.g. SSE
time = ChronoTime.now()
time = ChronoTime("2026-03-09 11:29:00+08:00")
# time about trading, only support 1min step now
time.is_trading()
# move 2 steps forward(2min), auto skip breaks and weekends
# e.g. 2026-03-09 11:29:00+08:00" -> "2026-03-09 13:01:00+08:00"
time.shift(2)
# shift preserve second and microsecond
time = ChronoTime("2026-03-09 11:29:33.123456+08:00")
# 2026-03-09 11:29:33.123456+08:00" -> "2026-03-09 13:01:33.123456+08:00"
time.shift(2)
# select valid trading times from self to end
# return series of 2 items, 11:29:00 and 13:00:00
time.trading_times(end=pd.Timestamp("2026-03-09 13:01:00+08:00"))
# series can aggregate, e.g. get all date in trading series
time.trading_times(end=pd.Timestamp("2026-03-09 13:01:00+08:00")).resample('D').first()
# move to the beginning of trading session which the time belongs to
# e.g. SSE "2026-03-08 11:29:00+08:00" belongs to session '2026-03-08', so the session start is '2026-03-08 09:30:00+08:00'
# e.g. CME session '2026-03-08' starts from '2026-03-07 17:00:00-06:00', so the session start is '2026-03-07 17:00:00-06:00', not '2026-03-08 00:00:00+00:00'
time.to_session_start()
# performance profiling
from chronosx_quant.performance import performance, PerformanceRegistry
@performance("slug_name")
def f1():
...
f1()
# get report of this function
print(PerformanceRegistry.get_report("slug_name"))
# get report of all functions
print(PerformanceRegistry.full_report())
# if you want to reset
PerformanceRegistry.clear()
# time travel
from chronosx_quant.mock import travel
with travel("2026-03-09 11:29:00+08:00"):
# only effect ChronoTime, datetime or pd.Timestamp still work
# thread-local mock, thread-safe
ChronoTime.now()
Add calendar
Chronosx based on pandas_market_calendars, so it can use all calendars in the project, and support to add custom calendars.
Add scheduler
I use static minute scheduler for speed, don't support multi step in the same time, and don't support extend schedule time range. It's ok to add new scheduler to support multi step or dynamic time range.
Benchmark
The benchmark suite uses pytest-benchmark.
Run the full benchmark file:
uv run pytest tests/benchmark_chrono.py --benchmark-only
Run a single benchmark:
uv run pytest tests/benchmark_chrono.py -k test_perf_is_trading --benchmark-only
Save benchmark results:
uv run pytest tests/benchmark_chrono.py --benchmark-only --benchmark-json=.benchmarks/chrono.json
Useful notes:
tests/benchmark_chrono.pyruns each benchmark acrossSSE,CME Globex Crypto, andICE--benchmark-onlyruns only benchmark tests and skips normal tests- if you want the usual pytest output without benchmark filtering, you can run
uv run pytest tests/benchmark_chrono.py
Benchmark preview:
- test machine: Intel Core i9-14900HX with 5600 MT/s memory
- most operations are in the
7-100 usrange trading_timesis around40-45 us- the slowest operations are
to_session_startandto_session_end, typically around0.2-0.26 ms - no benchmark in the current preview has an average latency above
1 ms - benchmark results may vary across machines and Python versions
Docker Service
The container service is implemented with FastAPI and exposes a JSON query API plus a Prometheus-compatible metrics endpoint.
Build and run with Docker:
docker build -t chronosx-quant .
docker run --rm -p 8000:8000 -e CALENDAR_NAME=SSE chronosx-quant
Run locally without Docker:
uv run --group docker python -m docker.service
Health check:
curl "http://localhost:8000/health"
Query the current trading status:
curl "http://localhost:8000/query"
Query a specific time:
curl "http://localhost:8000/query?time=2026-03-10T11:29:00"
curl "http://localhost:8000/query?time=2026-03-10T12:00:00&calendar_name=SSE"
The JSON response includes:
server_versioncalendar_nametimezonequery_timeis_trading_dayis_trading_timesession_startsession_endprevious_trading_timenext_trading_time
Calendar preview:
curl "http://localhost:8000/calendar_preview"
curl "http://localhost:8000/calendar_preview?calendar_name=SSE&days_ahead=32"
The preview response helps verify upcoming holidays and recent holiday definitions for a calendar. It includes:
calendar_namecalendar_full_nametodaydays_aheadrange_endlatest_holidaysupcoming_holidays
Prometheus metrics:
curl "http://localhost:8000/metrics"
Example output:
# HELP chronosx_service_info Static service metadata.
# TYPE chronosx_service_info gauge
chronosx_service_info{calendar_name="SSE",timezone="Asia/Shanghai",server_version="chronosx-quant/0.2.2"} 1
# HELP chronosx_trading_day Whether the evaluated time falls on a trading day.
# TYPE chronosx_trading_day gauge
chronosx_trading_day{calendar_name="SSE",timezone="Asia/Shanghai"} 1
# HELP chronosx_trading_time Whether the evaluated time falls inside trading hours.
# TYPE chronosx_trading_time gauge
chronosx_trading_time{calendar_name="SSE",timezone="Asia/Shanghai"} 0
The metrics response is generated with prometheus_client and a per-request custom registry. It avoids global collector state and does not expose query_time as a label.
You can scrape /metrics from Prometheus and alert with:
chronosx_trading_day == 1when alerts should only run on trading days.chronosx_trading_time == 1when alerts must be active only during market hours.
Project details
Release history Release notifications | RSS feed
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 chronosx_quant-0.2.2.tar.gz.
File metadata
- Download URL: chronosx_quant-0.2.2.tar.gz
- Upload date:
- Size: 96.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.11.2 {"installer":{"name":"uv","version":"0.11.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4d1dabe8291d87283b93dd6fb9da30c79f2ee3a4f3a751936dd5ed194eb16818
|
|
| MD5 |
fbdd1719cb3ec4d4a95a4a73fbdbccae
|
|
| BLAKE2b-256 |
0798e9ce801eadc05d20ff1bbe8c41154f132dc56f4e324a155e302cdc3142aa
|
File details
Details for the file chronosx_quant-0.2.2-py3-none-any.whl.
File metadata
- Download URL: chronosx_quant-0.2.2-py3-none-any.whl
- Upload date:
- Size: 14.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.11.2 {"installer":{"name":"uv","version":"0.11.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6e4395d9af265f07e06036c0a302ab015ee3469dfc7311a89293bcb2f62179b4
|
|
| MD5 |
2ef0644ac7ed80f804e90348da1e6638
|
|
| BLAKE2b-256 |
ff0c5052418388d4c47ad0fd4c5a1c654103ba8a50d035c81b00de705842ad40
|