Skip to content

Commit 89b92e1

Browse files
committed
Chore: repository maintenance, renaming, changelog update, and pyproject cleanup
1 parent 1e85c28 commit 89b92e1

15 files changed

Lines changed: 98 additions & 119 deletions

.env.example

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
TRADING_PLATFORM_COMMIT=afde290d6e5b9e1d47ae03e7ac6c2d03b250ae7f
1+
TRADING_FRAMEWORK_COMMIT=934d332c21bef56fa76c19f477143d8d438238c2

.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Clear and concise description of the issue.
99

1010
## Environment
1111

12-
- Trading Platform version:
12+
- Trading Framework version:
1313
- Python version:
1414
- Execution mode (local / cloud):
1515
- Strategy used:

.github/workflows/argo-build-and-backtest.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,6 @@ jobs:
8585
id: submit_build
8686
run: |
8787
export RUNTIME_COMMIT="${GITHUB_SHA}"
88-
export PLATFORM_COMMIT="${GITHUB_SHA}"
8988
export GIT_BRANCH="${{ needs.resolve-context.outputs.branch }}"
9089
9190
BUILD_NAME=$(

CHANGELOG.md

Lines changed: 45 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,57 @@
11
# Changelog
22

33
All notable changes to this project will be documented in this file.
4-
5-
The format is based on Keep a Changelog
6-
and this project adheres to Semantic Versioning.
4+
This project adheres to Semantic Versioning.
75

86
## [Unreleased]
97

10-
## [0.1.0] - 2026-02-17
8+
## [0.1.0] 2026-02-17
119

12-
Initial public release of the trading platform backtest core.
10+
Initial public release of the trading-runtime execution and orchestration layer.
1311

1412
### Added
1513

16-
#### Core Domain
17-
- Explicit order state machine
18-
- Structured domain types and reject reasons
19-
- Slot-based order tracking
20-
- Event bus and event sink abstractions
21-
- JSON schema validation for domain events
22-
23-
#### Risk Layer
24-
- Configurable risk engine
25-
- Risk constraint enforcement
26-
- Deterministic risk gating before execution
27-
28-
#### Backtest Layer
29-
- Integration with [hftbacktest](https://github.com/nkaz001/hftbacktest)
30-
- Strategy runner abstraction
31-
- Venue adapter interface
32-
- Deterministic event processing pipeline
33-
34-
#### Orchestration
35-
- Segment-based execution model
36-
- Parameter sweep runtime
37-
- Experiment and segment entrypoints
38-
- Prometheus metrics integration
39-
- MLflow-compatible logging hooks
40-
41-
#### Execution Modes
42-
- Fully local execution example
43-
- Cloud-native runtime entrypoints
44-
- S3-compatible storage adapter
45-
46-
#### Strategy Framework
47-
- Base strategy interface
48-
- Structured strategy configuration
49-
50-
#### Testing
51-
- Semantic invariant test suite
52-
- Order state transition validation
53-
- Queue dominance rules
54-
- Risk constraint validation
55-
- Schema conformance tests
14+
#### Runtime Execution
15+
16+
- Local deterministic backtest entrypoint
17+
- Argo workflow execution entrypoints
18+
- Structured runtime configuration model
19+
- Strategy execution adapters
20+
21+
#### Dependency Management
22+
23+
- Commit-pinned `trading-framework` integration
24+
- Reproducible dependency compilation via pip-tools
25+
- Environment bootstrap scripts
26+
27+
#### Containerization
28+
29+
- Deterministic Docker runtime image
30+
- GHCR push workflow template
31+
- Immutable runtime environment definition
32+
33+
#### Kubernetes & Orchestration
34+
35+
- Argo WorkflowTemplates for:
36+
- Image build & push
37+
- Backtest orchestration
38+
- microk8s-compatible deployment model
39+
- Namespace-based secret management for GHCR
40+
41+
#### CI & Infrastructure
42+
43+
- GitHub-hosted test workflow
44+
- Self-hosted runner for Kubernetes deployment
45+
- Automated Argo template deployment pipeline
46+
47+
#### Reproducibility
48+
49+
- Synthetic deterministic test datasets
50+
- Result artifact validation structure
51+
- Environment parity between local and cluster execution
5652

5753
#### Tooling
58-
- Dev container configuration
59-
- Development validation scripts
60-
- Dependency compilation helper
54+
55+
- Dev container bootstrap
56+
- Validation helpers
57+
- Dependency compilation script

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Thank you for your interest in contributing!
44

5-
This repository is a runtime example for the [trading-platform](https://github.com/trading-engineering/trading-platform) framework using
5+
This repository is a runtime example for the [trading-framework](https://github.com/trading-engineering/trading-framework) framework using
66
[Kubernetes](https://kubernetes.io) (via e.g. [MicroK8s](https://microk8s.io)) and [Argo Workflows](https://argoproj.github.io/workflows).
77
Contributions should preserve clarity, explicitness and reproducibility.
88

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
![License](https://img.shields.io/badge/license-MIT-green)
66

77
Runtime execution layer and orchestration environment for the
8-
[trading-platform](https://github.com/trading-engineering/trading-platform)
8+
[trading-framework](https://github.com/trading-engineering/trading-framework)
99
framework.
1010

1111
This repository provides:
@@ -20,10 +20,9 @@ This repository provides:
2020

2121
## 🧠 What is this?
2222

23-
`trading-runtime` is the execution and orchestration layer built on top of
24-
`trading-platform`.
23+
`trading-runtime` is the execution and orchestration layer built on top of `trading-framework`.
2524

26-
While `trading-platform` implements the deterministic trading framework,
25+
While `trading-framework` implements the deterministic trading framework,
2726
this repository focuses on:
2827

2928
- how strategies are executed
@@ -35,14 +34,14 @@ It intentionally contains no domain framework logic.
3534

3635
---
3736

38-
## 🧩 Relationship to trading-platform
37+
## 🧩 Relationship to trading-framework
3938

4039
```
41-
trading-platform → core framework, backtesting engine, domain logic
40+
trading-framework → core framework, backtesting engine, domain logic
4241
trading-runtime → executing entrypoints, runtime configs, orchestration
4342
```
4443

45-
The platform is consumed as a pinned Git dependency to guarantee
44+
The framework is consumed as a pinned Git dependency to guarantee
4645
deterministic runtime environments.
4746

4847
---
@@ -69,12 +68,12 @@ trading_runtime/strategies/ Example strategies
6968

7069
## 📌 Dependency Pinning & Reproducibility
7170

72-
The `trading-platform` dependency is pinned by commit SHA.
71+
The `trading-framework` dependency is pinned by commit SHA.
7372

7473
Create a `.env` file:
7574

7675
```bash
77-
TRADING_PLATFORM_COMMIT=<commit-sha>
76+
TRADING_FRAMEWORK_COMMIT=<commit-sha>
7877
```
7978

8079
Generate reproducible environments:
@@ -151,7 +150,7 @@ GitHub Container Registry (GHCR).
151150
This image contains:
152151

153152
- Python dependencies and entrypoints
154-
- trading-platform and trading-runtime commit SHA
153+
- trading-framework and trading-runtime commit SHA
155154
- strategies and configs
156155

157156
It acts as an immutable and deterministic runtime environment for all backtests.
@@ -229,7 +228,7 @@ Without this secret, the workflow cannot authenticate against GHCR, and Kubernet
229228

230229
| Script | Purpose |
231230
| ------------------------- | ----------------------------------------------- |
232-
| `compile-requirements.sh` | Pins trading-platform and resolves dependencies |
231+
| `compile-requirements.sh` | Pins trading-framework and resolves dependencies |
233232
| `post-create.sh` | Dev container bootstrap |
234233
| `check.sh` | Local validation helpers |
235234

argo/run-build.yaml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,7 @@ spec:
77
name: build-push-ghcr
88
arguments:
99
parameters:
10-
- name: trading_runtime_commit
11-
value: "${RUNTIME_COMMIT}"
12-
- name: trading_platform_commit
13-
value: "${PLATFORM_COMMIT}"
1410
- name: git_branch
1511
value: "${GIT_BRANCH}"
12+
- name: trading_runtime_commit
13+
value: "${RUNTIME_COMMIT}"

argo/workflowtemplate-backtest-fanout.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ spec:
104104

105105
command: [python, -m]
106106
args:
107-
- trading_platform.backtest.runtime.entrypoint
107+
- trading_framework.backtest.runtime.entrypoint
108108
- --config
109109
- "{{workflow.parameters.experiment_config}}"
110110
- --run
@@ -156,7 +156,7 @@ spec:
156156

157157
command: [python, -m]
158158
args:
159-
- trading_platform.backtest.runtime.run_sweep
159+
- trading_framework.backtest.runtime.run_sweep
160160
- --context
161161
- "{{inputs.parameters.sweep-path}}"
162162
- --scratch-root
@@ -204,7 +204,7 @@ spec:
204204

205205
command: [python, -m]
206206
args:
207-
- trading_platform.backtest.runtime.segment_finalize_entrypoint
207+
- trading_framework.backtest.runtime.segment_finalize_entrypoint
208208

209209
- "--experiment-id"
210210
- "{{inputs.parameters.experiment-id}}"
@@ -268,7 +268,7 @@ spec:
268268

269269
command: [python, -m]
270270
args:
271-
- trading_platform.backtest.runtime.experiment_finalize_entrypoint
271+
- trading_framework.backtest.runtime.experiment_finalize_entrypoint
272272

273273
- "--experiment-id"
274274
- "{{inputs.parameters.experiment-id}}"

argo/workflowtemplate-build-push-ghcr.yaml

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,6 @@ spec:
1717
description: "Exact commit SHA of trading-runtime"
1818
value: ""
1919

20-
- name: trading_platform_commit
21-
description: "Exact commit SHA of trading-platform"
22-
value: ""
23-
2420
templates:
2521
- name: build
2622
script:
@@ -32,10 +28,9 @@ spec:
3228
IMAGE_REPO="{{workflow.parameters.image_repo}}"
3329
GIT_BRANCH="{{workflow.parameters.git_branch}}"
3430
RUNTIME_COMMIT="{{workflow.parameters.trading_runtime_commit}}"
35-
PLATFORM_COMMIT="{{workflow.parameters.trading_platform_commit}}"
3631
37-
if [ -z "$RUNTIME_COMMIT" ] || [ -z "$PLATFORM_COMMIT" ]; then
38-
echo "Both trading_runtime_commit and trading_platform_commit must be set"
32+
if [ -z "$RUNTIME_COMMIT" ]; then
33+
echo "> trading_runtime_commit must be set"
3934
exit 1
4035
fi
4136
@@ -59,7 +54,6 @@ spec:
5954
--dockerfile=Dockerfile \
6055
--target=runtime \
6156
$DESTINATIONS \
62-
--build-arg=TRADING_PLATFORM_COMMIT=$PLATFORM_COMMIT \
6357
--build-arg=GIT_BRANCH=$GIT_BRANCH \
6458
--build-arg=GIT_COMMIT=$RUNTIME_COMMIT \
6559
--build-arg=GIT_DIRTY=0 \

pyproject.toml

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
55
[project]
66
name = "trading-runtime"
77
version = "0.1.0"
8-
description = "Trading runtime."
8+
description = "Runtime execution and Kubernetes orchestration layer for the trading-framework with reproducible environments and deterministic backtesting."
99
readme = "README.md"
1010
requires-python = ">=3.11"
1111
authors = [{ name = "tradingeng@protonmail.com" }]
@@ -18,10 +18,6 @@ classifiers = [
1818
"Operating System :: OS Independent"
1919
]
2020

21-
dependencies = [
22-
"trading-platform",
23-
]
24-
2521
[project.optional-dependencies]
2622
dev = [
2723
"pytest>=9,<10",

0 commit comments

Comments
 (0)