Skip to content

Commit 919508f

Browse files
committed
Prepare TradingCodex 0.1.0a6 release
1 parent 4f3e658 commit 919508f

8 files changed

Lines changed: 109 additions & 68 deletions

File tree

MANIFEST.in

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ include LICENSE
22
include NOTICE
33
include CONTRIBUTING.md
44
include TRADEMARKS.md
5+
include installation.md
56
include install.sh
67
recursive-include assets *
78
recursive-include docs *

README.md

Lines changed: 10 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212

1313
<div align="center">
1414
<a href="#quick-start">Quick Start</a> |
15+
<a href="installation.md">Installation</a> |
1516
<a href="#agent-topology">Agent Topology</a> |
1617
<a href="#architecture">Architecture</a> |
1718
<a href="#execution-boundary">Execution Boundary</a> |
@@ -31,82 +32,28 @@ the durable service layer, and TradingCodex MCP is the execution boundary.
3132

3233
## Quick Start
3334

34-
For Codex agents setting up `monarchjuno/tradingcodex` from a GitHub URL: this
35-
source repository is not the final workspace. Use it only as a package source if
36-
needed, then create a separate generated TradingCodex workspace with the
37-
installer below.
35+
Codex agents: do not clone this source repository for installation. Run the
36+
installer from the empty workspace the user wants configured.
3837

39-
Create an empty workspace directory, then bootstrap TradingCodex:
38+
Install TradingCodex into the current workspace:
4039

4140
```bash
42-
mkdir -p ~/tradingcodex-workspaces/apple-research
43-
cd ~/tradingcodex-workspaces/apple-research
41+
cd /path/to/empty-workspace
4442
curl -fsSL https://raw.githubusercontent.com/monarchjuno/tradingcodex/main/install.sh | sh -s -- .
4543
```
4644

47-
The installer renders a Codex-ready workspace, runs `./tcx doctor`, and records
48-
project MCP config. A directory with only `.git` already initialized is fine.
49-
50-
If you need the current GitHub `main` source instead of the PyPI package:
51-
52-
```bash
53-
curl -fsSL https://raw.githubusercontent.com/monarchjuno/tradingcodex/main/install.sh | sh -s -- --from-github .
54-
```
55-
56-
Source checkouts of this repository are for development. Generated TradingCodex
57-
workspaces are separate Codex projects.
58-
59-
Direct `uvx` equivalent:
60-
61-
```bash
62-
UV_NO_CACHE=1 uvx --isolated --refresh --python 3.14 --from tradingcodex python -m tradingcodex_cli init . && ./tcx doctor
63-
```
64-
65-
For repeated workspace creation, installing `tcx` as a user-level tool is still
66-
available:
67-
68-
```bash
69-
uv python install 3.14 && uv tool install --python 3.14 tradingcodex && uv tool update-shell
70-
```
71-
72-
Generated `.codex/config.toml` starts TradingCodex MCP with `uvx`, using the
73-
same package spec recorded at bootstrap time. That MCP startup also autostarts
74-
the experimental local Django dashboard service.
45+
After installation, fully quit and restart Codex, then open the generated
46+
workspace and start from a new thread so project MCP config is reloaded.
7547

7648
Start an orchestrated Codex workflow from the generated workspace:
7749

7850
```text
7951
$orchestrate-workflow analyze Apple with public equity research, valuation, portfolio, and risk review
8052
```
8153

82-
Open the workspace in Codex and trust the project. The generated project MCP
83-
config starts TradingCodex MCP and the local dashboard service together.
84-
85-
After Codex connects, these experimental local service surfaces are available:
86-
87-
- `http://127.0.0.1:8000/` for the work-in-progress visual harness dashboard
88-
- `http://127.0.0.1:8000/admin/` for the work-in-progress Django operations console
89-
90-
For CLI-only use outside Codex, the experimental dashboard service can still be
91-
started manually:
92-
93-
```bash
94-
./tcx service runserver
95-
```
96-
97-
Inspect the local MCP surface:
98-
99-
```bash
100-
printf '{"jsonrpc":"2.0","id":1,"method":"tools/list","params":{}}\n' | ./tcx mcp stdio
101-
```
102-
103-
Create and search DB-backed research memory:
104-
105-
```bash
106-
./tcx research create --markdown-file note.md --id note-1 --title "Research Note"
107-
./tcx research search "gross margin"
108-
./tcx research export note-1
109-
```
54+
See [installation.md](https://github.com/monarchjuno/tradingcodex/blob/main/installation.md)
55+
for GitHub-main installs, direct `uvx`, MCP/service details, and CLI smoke
56+
checks.
11057

11158
## Agent Topology
11259

docs/deployment.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ python3.14 -m venv /tmp/tcx-testpypi
133133
/tmp/tcx-testpypi/bin/pip install \
134134
--index-url https://test.pypi.org/simple/ \
135135
--extra-index-url https://pypi.org/simple/ \
136-
tradingcodex==0.1.0a5
136+
tradingcodex==0.1.0a6
137137
rm -rf /tmp/tcx-testpypi-smoke
138138
mkdir -p /tmp/tcx-testpypi-smoke
139139
cd /tmp/tcx-testpypi-smoke
@@ -162,7 +162,7 @@ After the PyPI workflow completes:
162162

163163
```bash
164164
python3.14 -m venv /tmp/tcx-pypi
165-
/tmp/tcx-pypi/bin/pip install tradingcodex==0.1.0a5
165+
/tmp/tcx-pypi/bin/pip install tradingcodex==0.1.0a6
166166
rm -rf /tmp/tcx-pypi-smoke
167167
mkdir -p /tmp/tcx-pypi-smoke
168168
cd /tmp/tcx-pypi-smoke
@@ -183,7 +183,7 @@ cd /tmp/tcx-install-sh-smoke
183183

184184
Use PEP 440 versions:
185185

186-
- `0.1.0a1`, `0.1.0a2`, `0.1.0a3`, `0.1.0a4`, `0.1.0a5` for alpha releases
186+
- `0.1.0a1`, `0.1.0a2`, `0.1.0a3`, `0.1.0a4`, `0.1.0a5`, `0.1.0a6` for alpha releases
187187
- `0.1.0b1` for beta releases
188188
- `0.1.0rc1` for release candidates
189189
- `0.1.0` only after install, docs, DB migration, and generated workspace

install.sh

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,3 +165,10 @@ fi
165165
if [ "$RUN_DOCTOR" = "1" ]; then
166166
(cd "$WORKSPACE" && ./tcx doctor)
167167
fi
168+
169+
cat >&2 <<EOF
170+
171+
install.sh: TradingCodex workspace is ready: $WORKSPACE
172+
install.sh: fully quit and restart Codex, then open this generated workspace
173+
install.sh: and start from a new thread so project MCP config is reloaded.
174+
EOF

installation.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# TradingCodex Installation
2+
3+
This guide covers install variants and smoke checks. For the shortest path, use
4+
the Quick Start in `README.md`.
5+
6+
## Agent Setup
7+
8+
Codex agents setting up `monarchjuno/tradingcodex` for a user should not clone
9+
this source repository for installation. Use the user's target workspace, then
10+
run the installer there.
11+
12+
```bash
13+
cd /path/to/empty-workspace
14+
curl -fsSL https://raw.githubusercontent.com/monarchjuno/tradingcodex/main/install.sh | sh -s -- .
15+
```
16+
17+
The target workspace should be empty. A directory with only `.git` already
18+
initialized is fine.
19+
20+
After installation, fully quit and restart Codex, then open the generated
21+
workspace and start from a new thread so project MCP config is reloaded.
22+
23+
## Install From GitHub Main
24+
25+
Use this when you need the current GitHub `main` source instead of the PyPI
26+
package:
27+
28+
```bash
29+
curl -fsSL https://raw.githubusercontent.com/monarchjuno/tradingcodex/main/install.sh | sh -s -- --from-github .
30+
```
31+
32+
Source checkouts of this repository are for development. Generated
33+
TradingCodex workspaces are separate Codex projects.
34+
35+
## Direct uvx Equivalent
36+
37+
The installer wraps this `uvx` flow:
38+
39+
```bash
40+
UV_NO_CACHE=1 uvx --isolated --refresh --python 3.14 --from tradingcodex python -m tradingcodex_cli init . && ./tcx doctor
41+
```
42+
43+
For repeated workspace creation, installing `tcx` as a user-level tool is also
44+
available:
45+
46+
```bash
47+
uv python install 3.14
48+
uv tool install --python 3.14 tradingcodex
49+
uv tool update-shell
50+
```
51+
52+
## Codex MCP And Local Service
53+
54+
Generated `.codex/config.toml` starts TradingCodex MCP with `uvx`, using the
55+
same package spec recorded at bootstrap time. MCP startup also autostarts the
56+
experimental local Django dashboard service.
57+
58+
Open the generated workspace in Codex and trust the project. After Codex
59+
connects, these experimental local service surfaces are available:
60+
61+
- `http://127.0.0.1:8000/` for the work-in-progress visual harness dashboard
62+
- `http://127.0.0.1:8000/admin/` for the work-in-progress Django operations console
63+
64+
For CLI-only use outside Codex, the experimental dashboard service can still be
65+
started manually:
66+
67+
```bash
68+
./tcx service runserver
69+
```
70+
71+
## Smoke Checks
72+
73+
Inspect the local MCP surface:
74+
75+
```bash
76+
printf '{"jsonrpc":"2.0","id":1,"method":"tools/list","params":{}}\n' | ./tcx mcp stdio
77+
```
78+
79+
Create and search DB-backed research memory:
80+
81+
```bash
82+
./tcx research create --markdown-file note.md --id note-1 --title "Research Note"
83+
./tcx research search "gross margin"
84+
./tcx research export note-1
85+
```

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
44

55
[project]
66
name = "tradingcodex"
7-
version = "0.1.0a5"
7+
version = "0.1.0a6"
88
description = "Codex-native trading harness with a Django service plane and MCP execution boundary."
99
readme = "README.md"
1010
requires-python = ">=3.14,<3.15"

tradingcodex_cli/__main__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ def init(argv: list[str]) -> None:
7070
print(f" cd {result['targetDir']}")
7171
print(" ./tcx doctor")
7272
print(" Open the workspace in Codex and trust it; TradingCodex MCP will start the experimental local dashboard service at http://127.0.0.1:8000/")
73+
print(" Fully quit and restart Codex, then start from a new thread in this generated workspace so project MCP config is reloaded.")
7374

7475

7576
def service(argv: list[str]) -> None:

tradingcodex_service/version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
TRADINGCODEX_VERSION = "0.1.0a5"
1+
TRADINGCODEX_VERSION = "0.1.0a6"

0 commit comments

Comments
 (0)