From f1e0888800908590422affce969e3a538eece202 Mon Sep 17 00:00:00 2001 From: Ninad Malvankar Date: Wed, 25 Mar 2026 16:23:07 +0530 Subject: [PATCH] fix: updated the folder name for examples --- README.md | 2 +- examples/README.md | 2 +- {interactive-examples => interactive_examples}/README.md | 4 ++-- .../arbitrage/currency_futures_spread.py | 0 .../arbitrage/etf_vs_index.py | 0 .../arbitrage/nse_bse_arbitrage.py | 0 .../futures_basis/banknifty_futures_spread.py | 0 .../futures_basis/cash_futures_basis.py | 0 .../futures_basis/futures_roll_cost.py | 0 .../futures_basis/mcx_crude_spread.py | 0 .../futures_basis/nifty_futures_spread.py | 0 .../historical_analysis/beta_calculator.py | 0 .../historical_analysis/historical_candle.py | 0 .../historical_analysis/historical_volatility.py | 0 .../historical_analysis/moving_average.py | 0 .../historical_analysis/stock_correlation.py | 0 .../historical_analysis/vwap.py | 0 .../historical_analysis/week_52_high_low.py | 0 .../instrument_search/search_equity.py | 0 .../instrument_search/search_futures.py | 0 .../instrument_search/search_options.py | 0 .../market_data/intraday_chart.py | 0 .../market_data/live_depth.py | 0 .../market_data/live_depth_d30.py | 0 .../market_data/live_depth_mcx.py | 0 .../market_data/live_depth_usdinr.py | 0 .../market_data/market_holidays.py | 0 .../market_data/market_status.py | 0 .../market_data/market_timings.py | 0 .../options_analytics/expiry_decay.py | 0 .../options_analytics/gamma_exposure.py | 0 .../options_analytics/implied_move.py | 0 .../options_analytics/iv_percentile.py | 0 .../options_analytics/max_pain_calculator.py | 0 .../options_analytics/oi_skew.py | 0 .../options_analytics/option_chain_native.py | 0 .../options_analytics/option_greeks.py | 0 .../options_analytics/options_chain_builder.py | 0 .../options_analytics/pcr_trend.py | 0 .../options_analytics/volatility_skew.py | 0 .../options_strategies/bull_call_spread.py | 0 .../options_strategies/butterfly_spread.py | 0 .../options_strategies/calendar_spread_options.py | 0 .../options_strategies/iron_condor_setup.py | 0 .../options_strategies/put_call_parity.py | 0 .../options_strategies/straddle_pricer.py | 0 .../options_strategies/strangle_pricer.py | 0 .../portfolio_screening/futures_oi_buildup.py | 0 .../portfolio_screening/sector_index_comparison.py | 0 .../portfolio_screening/top_volume_stocks.py | 0 .../requirements.txt | 0 {interactive-examples => interactive_examples}/test_runner.py | 0 {interactive-examples => interactive_examples}/utils.py | 0 53 files changed, 4 insertions(+), 4 deletions(-) rename {interactive-examples => interactive_examples}/README.md (99%) rename {interactive-examples => interactive_examples}/arbitrage/currency_futures_spread.py (100%) rename {interactive-examples => interactive_examples}/arbitrage/etf_vs_index.py (100%) rename {interactive-examples => interactive_examples}/arbitrage/nse_bse_arbitrage.py (100%) rename {interactive-examples => interactive_examples}/futures_basis/banknifty_futures_spread.py (100%) rename {interactive-examples => interactive_examples}/futures_basis/cash_futures_basis.py (100%) rename {interactive-examples => interactive_examples}/futures_basis/futures_roll_cost.py (100%) rename {interactive-examples => interactive_examples}/futures_basis/mcx_crude_spread.py (100%) rename {interactive-examples => interactive_examples}/futures_basis/nifty_futures_spread.py (100%) rename {interactive-examples => interactive_examples}/historical_analysis/beta_calculator.py (100%) rename {interactive-examples => interactive_examples}/historical_analysis/historical_candle.py (100%) rename {interactive-examples => interactive_examples}/historical_analysis/historical_volatility.py (100%) rename {interactive-examples => interactive_examples}/historical_analysis/moving_average.py (100%) rename {interactive-examples => interactive_examples}/historical_analysis/stock_correlation.py (100%) rename {interactive-examples => interactive_examples}/historical_analysis/vwap.py (100%) rename {interactive-examples => interactive_examples}/historical_analysis/week_52_high_low.py (100%) rename {interactive-examples => interactive_examples}/instrument_search/search_equity.py (100%) rename {interactive-examples => interactive_examples}/instrument_search/search_futures.py (100%) rename {interactive-examples => interactive_examples}/instrument_search/search_options.py (100%) rename {interactive-examples => interactive_examples}/market_data/intraday_chart.py (100%) rename {interactive-examples => interactive_examples}/market_data/live_depth.py (100%) rename {interactive-examples => interactive_examples}/market_data/live_depth_d30.py (100%) rename {interactive-examples => interactive_examples}/market_data/live_depth_mcx.py (100%) rename {interactive-examples => interactive_examples}/market_data/live_depth_usdinr.py (100%) rename {interactive-examples => interactive_examples}/market_data/market_holidays.py (100%) rename {interactive-examples => interactive_examples}/market_data/market_status.py (100%) rename {interactive-examples => interactive_examples}/market_data/market_timings.py (100%) rename {interactive-examples => interactive_examples}/options_analytics/expiry_decay.py (100%) rename {interactive-examples => interactive_examples}/options_analytics/gamma_exposure.py (100%) rename {interactive-examples => interactive_examples}/options_analytics/implied_move.py (100%) rename {interactive-examples => interactive_examples}/options_analytics/iv_percentile.py (100%) rename {interactive-examples => interactive_examples}/options_analytics/max_pain_calculator.py (100%) rename {interactive-examples => interactive_examples}/options_analytics/oi_skew.py (100%) rename {interactive-examples => interactive_examples}/options_analytics/option_chain_native.py (100%) rename {interactive-examples => interactive_examples}/options_analytics/option_greeks.py (100%) rename {interactive-examples => interactive_examples}/options_analytics/options_chain_builder.py (100%) rename {interactive-examples => interactive_examples}/options_analytics/pcr_trend.py (100%) rename {interactive-examples => interactive_examples}/options_analytics/volatility_skew.py (100%) rename {interactive-examples => interactive_examples}/options_strategies/bull_call_spread.py (100%) rename {interactive-examples => interactive_examples}/options_strategies/butterfly_spread.py (100%) rename {interactive-examples => interactive_examples}/options_strategies/calendar_spread_options.py (100%) rename {interactive-examples => interactive_examples}/options_strategies/iron_condor_setup.py (100%) rename {interactive-examples => interactive_examples}/options_strategies/put_call_parity.py (100%) rename {interactive-examples => interactive_examples}/options_strategies/straddle_pricer.py (100%) rename {interactive-examples => interactive_examples}/options_strategies/strangle_pricer.py (100%) rename {interactive-examples => interactive_examples}/portfolio_screening/futures_oi_buildup.py (100%) rename {interactive-examples => interactive_examples}/portfolio_screening/sector_index_comparison.py (100%) rename {interactive-examples => interactive_examples}/portfolio_screening/top_volume_stocks.py (100%) rename {interactive-examples => interactive_examples}/requirements.txt (100%) rename {interactive-examples => interactive_examples}/test_runner.py (100%) rename {interactive-examples => interactive_examples}/utils.py (100%) diff --git a/README.md b/README.md index da06987..369b120 100644 --- a/README.md +++ b/README.md @@ -116,7 +116,7 @@ The [`examples/`](examples/) folder contains ready-to-run scripts covering commo ## Interactive Examples -The [interactive-examples/](interactive-examples/) directory contains 47 ready-to-run CLI scripts across 8 categories: instrument search, futures basis, options strategies, options analytics, arbitrage, historical analysis, portfolio screening, and market data. See the [interactive-examples README](interactive-examples/README.md) for details. +The [interactive_examples/](interactive_examples/) directory contains 47 ready-to-run CLI scripts across 8 categories: instrument search, futures basis, options strategies, options analytics, arbitrage, historical analysis, portfolio screening, and market data. See the [interactive_examples README](interactive_examples/README.md) for details. The [`examples/strategies/`](examples/strategies/) folder is organized by market outlook: diff --git a/examples/README.md b/examples/README.md index 33be678..f85e1f9 100644 --- a/examples/README.md +++ b/examples/README.md @@ -99,7 +99,7 @@ Each strategy script searches for the required Nifty 50 option legs using the In ## Interactive Examples -For 47 complete, runnable CLI scripts covering instrument search, futures spreads, options strategies, options analytics, arbitrage, historical analysis, and more, see the [interactive-examples/](../interactive-examples/) directory. +For 47 complete, runnable CLI scripts covering instrument search, futures spreads, options strategies, options analytics, arbitrage, historical analysis, and more, see the [interactive_examples/](../interactive_examples/) directory. ## Documentation diff --git a/interactive-examples/README.md b/interactive_examples/README.md similarity index 99% rename from interactive-examples/README.md rename to interactive_examples/README.md index c0f4a54..5b8820e 100644 --- a/interactive-examples/README.md +++ b/interactive_examples/README.md @@ -10,7 +10,7 @@ ## Quick Start ```bash -cd interactive-examples +cd interactive_examples pip install -r requirements.txt python instrument_search/search_equity.py --token --query RELIANCE ``` @@ -207,7 +207,7 @@ python market_data/live_depth_mcx.py --token # Ctrl-C to stop ## Project Structure ``` -interactive-examples/ +interactive_examples/ ├── utils.py # Shared helpers — SDK client, search, quotes, history ├── test_runner.py # Automated test harness for all examples ├── requirements.txt diff --git a/interactive-examples/arbitrage/currency_futures_spread.py b/interactive_examples/arbitrage/currency_futures_spread.py similarity index 100% rename from interactive-examples/arbitrage/currency_futures_spread.py rename to interactive_examples/arbitrage/currency_futures_spread.py diff --git a/interactive-examples/arbitrage/etf_vs_index.py b/interactive_examples/arbitrage/etf_vs_index.py similarity index 100% rename from interactive-examples/arbitrage/etf_vs_index.py rename to interactive_examples/arbitrage/etf_vs_index.py diff --git a/interactive-examples/arbitrage/nse_bse_arbitrage.py b/interactive_examples/arbitrage/nse_bse_arbitrage.py similarity index 100% rename from interactive-examples/arbitrage/nse_bse_arbitrage.py rename to interactive_examples/arbitrage/nse_bse_arbitrage.py diff --git a/interactive-examples/futures_basis/banknifty_futures_spread.py b/interactive_examples/futures_basis/banknifty_futures_spread.py similarity index 100% rename from interactive-examples/futures_basis/banknifty_futures_spread.py rename to interactive_examples/futures_basis/banknifty_futures_spread.py diff --git a/interactive-examples/futures_basis/cash_futures_basis.py b/interactive_examples/futures_basis/cash_futures_basis.py similarity index 100% rename from interactive-examples/futures_basis/cash_futures_basis.py rename to interactive_examples/futures_basis/cash_futures_basis.py diff --git a/interactive-examples/futures_basis/futures_roll_cost.py b/interactive_examples/futures_basis/futures_roll_cost.py similarity index 100% rename from interactive-examples/futures_basis/futures_roll_cost.py rename to interactive_examples/futures_basis/futures_roll_cost.py diff --git a/interactive-examples/futures_basis/mcx_crude_spread.py b/interactive_examples/futures_basis/mcx_crude_spread.py similarity index 100% rename from interactive-examples/futures_basis/mcx_crude_spread.py rename to interactive_examples/futures_basis/mcx_crude_spread.py diff --git a/interactive-examples/futures_basis/nifty_futures_spread.py b/interactive_examples/futures_basis/nifty_futures_spread.py similarity index 100% rename from interactive-examples/futures_basis/nifty_futures_spread.py rename to interactive_examples/futures_basis/nifty_futures_spread.py diff --git a/interactive-examples/historical_analysis/beta_calculator.py b/interactive_examples/historical_analysis/beta_calculator.py similarity index 100% rename from interactive-examples/historical_analysis/beta_calculator.py rename to interactive_examples/historical_analysis/beta_calculator.py diff --git a/interactive-examples/historical_analysis/historical_candle.py b/interactive_examples/historical_analysis/historical_candle.py similarity index 100% rename from interactive-examples/historical_analysis/historical_candle.py rename to interactive_examples/historical_analysis/historical_candle.py diff --git a/interactive-examples/historical_analysis/historical_volatility.py b/interactive_examples/historical_analysis/historical_volatility.py similarity index 100% rename from interactive-examples/historical_analysis/historical_volatility.py rename to interactive_examples/historical_analysis/historical_volatility.py diff --git a/interactive-examples/historical_analysis/moving_average.py b/interactive_examples/historical_analysis/moving_average.py similarity index 100% rename from interactive-examples/historical_analysis/moving_average.py rename to interactive_examples/historical_analysis/moving_average.py diff --git a/interactive-examples/historical_analysis/stock_correlation.py b/interactive_examples/historical_analysis/stock_correlation.py similarity index 100% rename from interactive-examples/historical_analysis/stock_correlation.py rename to interactive_examples/historical_analysis/stock_correlation.py diff --git a/interactive-examples/historical_analysis/vwap.py b/interactive_examples/historical_analysis/vwap.py similarity index 100% rename from interactive-examples/historical_analysis/vwap.py rename to interactive_examples/historical_analysis/vwap.py diff --git a/interactive-examples/historical_analysis/week_52_high_low.py b/interactive_examples/historical_analysis/week_52_high_low.py similarity index 100% rename from interactive-examples/historical_analysis/week_52_high_low.py rename to interactive_examples/historical_analysis/week_52_high_low.py diff --git a/interactive-examples/instrument_search/search_equity.py b/interactive_examples/instrument_search/search_equity.py similarity index 100% rename from interactive-examples/instrument_search/search_equity.py rename to interactive_examples/instrument_search/search_equity.py diff --git a/interactive-examples/instrument_search/search_futures.py b/interactive_examples/instrument_search/search_futures.py similarity index 100% rename from interactive-examples/instrument_search/search_futures.py rename to interactive_examples/instrument_search/search_futures.py diff --git a/interactive-examples/instrument_search/search_options.py b/interactive_examples/instrument_search/search_options.py similarity index 100% rename from interactive-examples/instrument_search/search_options.py rename to interactive_examples/instrument_search/search_options.py diff --git a/interactive-examples/market_data/intraday_chart.py b/interactive_examples/market_data/intraday_chart.py similarity index 100% rename from interactive-examples/market_data/intraday_chart.py rename to interactive_examples/market_data/intraday_chart.py diff --git a/interactive-examples/market_data/live_depth.py b/interactive_examples/market_data/live_depth.py similarity index 100% rename from interactive-examples/market_data/live_depth.py rename to interactive_examples/market_data/live_depth.py diff --git a/interactive-examples/market_data/live_depth_d30.py b/interactive_examples/market_data/live_depth_d30.py similarity index 100% rename from interactive-examples/market_data/live_depth_d30.py rename to interactive_examples/market_data/live_depth_d30.py diff --git a/interactive-examples/market_data/live_depth_mcx.py b/interactive_examples/market_data/live_depth_mcx.py similarity index 100% rename from interactive-examples/market_data/live_depth_mcx.py rename to interactive_examples/market_data/live_depth_mcx.py diff --git a/interactive-examples/market_data/live_depth_usdinr.py b/interactive_examples/market_data/live_depth_usdinr.py similarity index 100% rename from interactive-examples/market_data/live_depth_usdinr.py rename to interactive_examples/market_data/live_depth_usdinr.py diff --git a/interactive-examples/market_data/market_holidays.py b/interactive_examples/market_data/market_holidays.py similarity index 100% rename from interactive-examples/market_data/market_holidays.py rename to interactive_examples/market_data/market_holidays.py diff --git a/interactive-examples/market_data/market_status.py b/interactive_examples/market_data/market_status.py similarity index 100% rename from interactive-examples/market_data/market_status.py rename to interactive_examples/market_data/market_status.py diff --git a/interactive-examples/market_data/market_timings.py b/interactive_examples/market_data/market_timings.py similarity index 100% rename from interactive-examples/market_data/market_timings.py rename to interactive_examples/market_data/market_timings.py diff --git a/interactive-examples/options_analytics/expiry_decay.py b/interactive_examples/options_analytics/expiry_decay.py similarity index 100% rename from interactive-examples/options_analytics/expiry_decay.py rename to interactive_examples/options_analytics/expiry_decay.py diff --git a/interactive-examples/options_analytics/gamma_exposure.py b/interactive_examples/options_analytics/gamma_exposure.py similarity index 100% rename from interactive-examples/options_analytics/gamma_exposure.py rename to interactive_examples/options_analytics/gamma_exposure.py diff --git a/interactive-examples/options_analytics/implied_move.py b/interactive_examples/options_analytics/implied_move.py similarity index 100% rename from interactive-examples/options_analytics/implied_move.py rename to interactive_examples/options_analytics/implied_move.py diff --git a/interactive-examples/options_analytics/iv_percentile.py b/interactive_examples/options_analytics/iv_percentile.py similarity index 100% rename from interactive-examples/options_analytics/iv_percentile.py rename to interactive_examples/options_analytics/iv_percentile.py diff --git a/interactive-examples/options_analytics/max_pain_calculator.py b/interactive_examples/options_analytics/max_pain_calculator.py similarity index 100% rename from interactive-examples/options_analytics/max_pain_calculator.py rename to interactive_examples/options_analytics/max_pain_calculator.py diff --git a/interactive-examples/options_analytics/oi_skew.py b/interactive_examples/options_analytics/oi_skew.py similarity index 100% rename from interactive-examples/options_analytics/oi_skew.py rename to interactive_examples/options_analytics/oi_skew.py diff --git a/interactive-examples/options_analytics/option_chain_native.py b/interactive_examples/options_analytics/option_chain_native.py similarity index 100% rename from interactive-examples/options_analytics/option_chain_native.py rename to interactive_examples/options_analytics/option_chain_native.py diff --git a/interactive-examples/options_analytics/option_greeks.py b/interactive_examples/options_analytics/option_greeks.py similarity index 100% rename from interactive-examples/options_analytics/option_greeks.py rename to interactive_examples/options_analytics/option_greeks.py diff --git a/interactive-examples/options_analytics/options_chain_builder.py b/interactive_examples/options_analytics/options_chain_builder.py similarity index 100% rename from interactive-examples/options_analytics/options_chain_builder.py rename to interactive_examples/options_analytics/options_chain_builder.py diff --git a/interactive-examples/options_analytics/pcr_trend.py b/interactive_examples/options_analytics/pcr_trend.py similarity index 100% rename from interactive-examples/options_analytics/pcr_trend.py rename to interactive_examples/options_analytics/pcr_trend.py diff --git a/interactive-examples/options_analytics/volatility_skew.py b/interactive_examples/options_analytics/volatility_skew.py similarity index 100% rename from interactive-examples/options_analytics/volatility_skew.py rename to interactive_examples/options_analytics/volatility_skew.py diff --git a/interactive-examples/options_strategies/bull_call_spread.py b/interactive_examples/options_strategies/bull_call_spread.py similarity index 100% rename from interactive-examples/options_strategies/bull_call_spread.py rename to interactive_examples/options_strategies/bull_call_spread.py diff --git a/interactive-examples/options_strategies/butterfly_spread.py b/interactive_examples/options_strategies/butterfly_spread.py similarity index 100% rename from interactive-examples/options_strategies/butterfly_spread.py rename to interactive_examples/options_strategies/butterfly_spread.py diff --git a/interactive-examples/options_strategies/calendar_spread_options.py b/interactive_examples/options_strategies/calendar_spread_options.py similarity index 100% rename from interactive-examples/options_strategies/calendar_spread_options.py rename to interactive_examples/options_strategies/calendar_spread_options.py diff --git a/interactive-examples/options_strategies/iron_condor_setup.py b/interactive_examples/options_strategies/iron_condor_setup.py similarity index 100% rename from interactive-examples/options_strategies/iron_condor_setup.py rename to interactive_examples/options_strategies/iron_condor_setup.py diff --git a/interactive-examples/options_strategies/put_call_parity.py b/interactive_examples/options_strategies/put_call_parity.py similarity index 100% rename from interactive-examples/options_strategies/put_call_parity.py rename to interactive_examples/options_strategies/put_call_parity.py diff --git a/interactive-examples/options_strategies/straddle_pricer.py b/interactive_examples/options_strategies/straddle_pricer.py similarity index 100% rename from interactive-examples/options_strategies/straddle_pricer.py rename to interactive_examples/options_strategies/straddle_pricer.py diff --git a/interactive-examples/options_strategies/strangle_pricer.py b/interactive_examples/options_strategies/strangle_pricer.py similarity index 100% rename from interactive-examples/options_strategies/strangle_pricer.py rename to interactive_examples/options_strategies/strangle_pricer.py diff --git a/interactive-examples/portfolio_screening/futures_oi_buildup.py b/interactive_examples/portfolio_screening/futures_oi_buildup.py similarity index 100% rename from interactive-examples/portfolio_screening/futures_oi_buildup.py rename to interactive_examples/portfolio_screening/futures_oi_buildup.py diff --git a/interactive-examples/portfolio_screening/sector_index_comparison.py b/interactive_examples/portfolio_screening/sector_index_comparison.py similarity index 100% rename from interactive-examples/portfolio_screening/sector_index_comparison.py rename to interactive_examples/portfolio_screening/sector_index_comparison.py diff --git a/interactive-examples/portfolio_screening/top_volume_stocks.py b/interactive_examples/portfolio_screening/top_volume_stocks.py similarity index 100% rename from interactive-examples/portfolio_screening/top_volume_stocks.py rename to interactive_examples/portfolio_screening/top_volume_stocks.py diff --git a/interactive-examples/requirements.txt b/interactive_examples/requirements.txt similarity index 100% rename from interactive-examples/requirements.txt rename to interactive_examples/requirements.txt diff --git a/interactive-examples/test_runner.py b/interactive_examples/test_runner.py similarity index 100% rename from interactive-examples/test_runner.py rename to interactive_examples/test_runner.py diff --git a/interactive-examples/utils.py b/interactive_examples/utils.py similarity index 100% rename from interactive-examples/utils.py rename to interactive_examples/utils.py