diff --git a/src/quant_research_starter/dashboard/streamlit_app.py b/legacy/streamlit/streamlit_app.py similarity index 100% rename from src/quant_research_starter/dashboard/streamlit_app.py rename to legacy/streamlit/streamlit_app.py diff --git a/src/quant_research_starter.egg-info/PKG-INFO b/src/quant_research_starter.egg-info/PKG-INFO index 189a179..576ec9c 100644 --- a/src/quant_research_starter.egg-info/PKG-INFO +++ b/src/quant_research_starter.egg-info/PKG-INFO @@ -96,6 +96,29 @@ pip install -e ".[dev]" pip install streamlit plotly ``` +### Quick CLI Usage + +After installation, you can use the CLI in two ways: + +**Option 1: Direct command (if PATH is configured)** +```bash +qrs --help +# generate synthetic sample price series +qrs generate-data -o data_sample/sample_prices.csv -s 5 -d 365 +# compute example factors +qrs compute-factors -d data_sample/sample_prices.csv -f momentum -f value -o output/factors.csv +# run a backtest +qrs backtest -d data_sample/sample_prices.csv -s output/factors.csv -o output/backtest_results.json +``` + +**Option 2: Python module (always works)** +```bash +python -m quant_research_starter.cli --help +python -m quant_research_starter.cli generate-data -o data_sample/sample_prices.csv -s 5 -d 365 +python -m quant_research_starter.cli compute-factors -d data_sample/sample_prices.csv -f momentum -f value +python -m quant_research_starter.cli backtest -d data_sample/sample_prices.csv -s output/factors.csv -o output/backtest_results.json +``` + ### Demo (one-line) ```bash @@ -106,13 +129,13 @@ make demo ```bash # generate synthetic sample price series -qrs generate-data -o data_sample/sample_prices.csv -s 5 -d 365 +python -m quant_research_starter.cli generate-data -o data_sample/sample_prices.csv -s 5 -d 365 # compute example factors -qrs compute-factors -d data_sample/sample_prices.csv -f momentum -f value -o output/factors.csv +python -m quant_research_starter.cli compute-factors -d data_sample/sample_prices.csv -f momentum -f value -o output/factors.csv # run a backtest -qrs backtest -d data_sample/sample_prices.csv -s output/factors.csv -o output/backtest_results.json +python -m quant_research_starter.cli backtest -d data_sample/sample_prices.csv -s output/factors.csv -o output/backtest_results.json # optional: start the Streamlit dashboard streamlit run src/quant_research_starter/dashboard/streamlit_app.py @@ -166,11 +189,13 @@ Supported frequencies: ## CLI reference -Run `qrs --help` or `qrs --help` for full usage. Main commands include: +Run `python -m quant_research_starter.cli --help` or `python -m quant_research_starter.cli --help` for full usage. Main commands include: + +* `python -m quant_research_starter.cli generate-data` — create synthetic price series or download data from adapters +* `python -m quant_research_starter.cli compute-factors` — calculate and export factor scores +* `python -m quant_research_starter.cli backtest` — run the vectorized backtest and export results -* `qrs generate-data` — create synthetic price series or download data from adapters -* `qrs compute-factors` — calculate and export factor scores -* `qrs backtest` — run the vectorized backtest and export results +**Note:** If you have the `qrs` command in your PATH, you can use `qrs` instead of `python -m quant_research_starter.cli`. --- diff --git a/src/quant_research_starter.egg-info/SOURCES.txt b/src/quant_research_starter.egg-info/SOURCES.txt index 67dbfff..fd7f853 100644 --- a/src/quant_research_starter.egg-info/SOURCES.txt +++ b/src/quant_research_starter.egg-info/SOURCES.txt @@ -18,6 +18,7 @@ src/quant_research_starter/data/downloaders.py src/quant_research_starter/data/init.py src/quant_research_starter/data/sample_loader.py src/quant_research_starter/data/synthetic.py +src/quant_research_starter/data/validator.py src/quant_research_starter/examples/benchmark/benchmark_factors.py src/quant_research_starter/factors/__init__.py src/quant_research_starter/factors/base.py @@ -28,9 +29,12 @@ src/quant_research_starter/factors/size.py src/quant_research_starter/factors/value.py src/quant_research_starter/factors/volatility.py src/quant_research_starter/metrics/__init__.py +src/quant_research_starter/metrics/plotting.py src/quant_research_starter/metrics/risk.py src/quant_research_starter/universe/selection.py tests/test_backtest.py tests/test_data.py tests/test_factors.py -tests/test_metrics.py \ No newline at end of file +tests/test_metrics.py +tests/test_plotting.py +tests/test_validator.py \ No newline at end of file