Skip to content

Commit d0d1d26

Browse files
revert: reverts PR
This reverts commit 40bc780.
1 parent 40bc780 commit d0d1d26

File tree

4 files changed

+7
-146
lines changed

4 files changed

+7
-146
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,3 @@ node_modules
44
__pycache__/
55
*.py[cod]
66
*$py.class
7-
src/quant_research_starter.egg-info/PKG-INFO

README.md

Lines changed: 7 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -53,29 +53,6 @@ pip install -e ".[dev]"
5353
pip install streamlit plotly
5454
```
5555

56-
### Quick CLI Usage
57-
58-
After installation, you can use the CLI in two ways:
59-
60-
**Option 1: Direct command (if PATH is configured)**
61-
```bash
62-
qrs --help
63-
# generate synthetic sample price series
64-
qrs generate-data -o data_sample/sample_prices.csv -s 5 -d 365
65-
# compute example factors
66-
qrs compute-factors -d data_sample/sample_prices.csv -f momentum -f value -o output/factors.csv
67-
# run a backtest
68-
qrs backtest -d data_sample/sample_prices.csv -s output/factors.csv -o output/backtest_results.json
69-
```
70-
71-
**Option 2: Python module (always works)**
72-
```bash
73-
python -m quant_research_starter.cli --help
74-
python -m quant_research_starter.cli generate-data -o data_sample/sample_prices.csv -s 5 -d 365
75-
python -m quant_research_starter.cli compute-factors -d data_sample/sample_prices.csv -f momentum -f value
76-
python -m quant_research_starter.cli backtest -d data_sample/sample_prices.csv -s output/factors.csv -o output/backtest_results.json
77-
```
78-
7956
### Demo (one-line)
8057

8158
```bash
@@ -86,13 +63,13 @@ make demo
8663

8764
```bash
8865
# generate synthetic sample price series
89-
python -m quant_research_starter.cli generate-data -o data_sample/sample_prices.csv -s 5 -d 365
66+
qrs generate-data -o data_sample/sample_prices.csv -s 5 -d 365
9067

9168
# compute example factors
92-
python -m quant_research_starter.cli compute-factors -d data_sample/sample_prices.csv -f momentum -f value -o output/factors.csv
69+
qrs compute-factors -d data_sample/sample_prices.csv -f momentum -f value -o output/factors.csv
9370

9471
# run a backtest
95-
python -m quant_research_starter.cli backtest -d data_sample/sample_prices.csv -s output/factors.csv -o output/backtest_results.json
72+
qrs backtest -d data_sample/sample_prices.csv -s output/factors.csv -o output/backtest_results.json
9673

9774
# optional: start the Streamlit dashboard
9875
streamlit run src/quant_research_starter/dashboard/streamlit_app.py
@@ -146,13 +123,11 @@ Supported frequencies:
146123

147124
## CLI reference
148125

149-
Run `python -m quant_research_starter.cli --help` or `python -m quant_research_starter.cli <command> --help` for full usage. Main commands include:
150-
151-
* `python -m quant_research_starter.cli generate-data` — create synthetic price series or download data from adapters
152-
* `python -m quant_research_starter.cli compute-factors` — calculate and export factor scores
153-
* `python -m quant_research_starter.cli backtest` — run the vectorized backtest and export results
126+
Run `qrs --help` or `qrs <command> --help` for full usage. Main commands include:
154127

155-
**Note:** If you have the `qrs` command in your PATH, you can use `qrs` instead of `python -m quant_research_starter.cli`.
128+
* `qrs generate-data` — create synthetic price series or download data from adapters
129+
* `qrs compute-factors` — calculate and export factor scores
130+
* `qrs backtest` — run the vectorized backtest and export results
156131

157132
---
158133

pyproject.toml

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,12 +59,6 @@ qrs = "quant_research_starter.cli:cli"
5959
requires = ["setuptools>=45", "wheel"]
6060
build-backend = "setuptools.build_meta"
6161

62-
[tool.setuptools.packages.find]
63-
where = ["src"]
64-
65-
[tool.setuptools.package-dir]
66-
"" = "src"
67-
6862
[tool.black]
6963
line-length = 88
7064
target-version = ['py310']

test_cli.py

Lines changed: 0 additions & 107 deletions
This file was deleted.

0 commit comments

Comments
 (0)