quantjourney-bidask 0.5.0__py3-none-any.whl → 0.6.0__py3-none-any.whl

quantjourney_bidask/_version.py

@@ -1,6 +1,6 @@
 """Version information for quantjourney_bidask."""
 
-__version__ = "0.1.0"
+__version__ = "0.6.0"
 __author__ = "Jakub Polec"
 __email__ = "jakub@quantjourney.pro"
 __license__ = "Apache License 2.0"

{quantjourney_bidask-0.5.0.dist-info → quantjourney_bidask-0.6.0.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: quantjourney-bidask
-Version: 0.5.0
-Summary: Efficient bid-ask spread estimator from OHLC prices
+Version: 0.6.0
+Summary: Efficient bid-ask spread estimator from OHLC prices with simplified data fetching for stocks and crypto
 Author-email: Jakub Polec <jakub@quantjourney.pro>
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/QuantJourneyOrg/qj_bidask
@@ -26,6 +26,7 @@ Requires-Dist: yfinance>=0.2
 Requires-Dist: matplotlib>=3.5
 Requires-Dist: plotly>=5.0
 Requires-Dist: websocket-client>=1.0
+Requires-Dist: ccxt>=4.0
 Provides-Extra: dev
 Requires-Dist: pytest>=7.0; extra == "dev"
 Requires-Dist: pytest-mock>=3.10; extra == "dev"
@@ -54,7 +55,10 @@ This library is designed for quantitative finance professionals, researchers, an
 ## Features
 
 - **Efficient Spread Estimation**: Implements the EDGE estimator for single, rolling, and expanding windows.
-- **Data Integration**: Fetch OHLC data from Binance (via custom FastAPI server) and Yahoo Finance (via yfinance).
+- **Real-Time Data**: Websocket support for live cryptocurrency data from Binance and other exchanges.
+- **Data Integration**: Fetch OHLC data from Yahoo Finance and generate synthetic data for testing.
+- **Live Monitoring**: Real-time spread monitoring with animated visualizations.
+- **Local Development**: Works completely locally without cloud dependencies.
 - **Robust Handling**: Supports missing values, non-positive prices, and various data frequencies.
 - **Comprehensive Tests**: Extensive unit tests with known test cases from the original paper.
 - **Clear Documentation**: Detailed docstrings and usage examples.
@@ -67,6 +71,14 @@ Install the library via pip:
 pip install quantjourney-bidask
 ```
 
+For development (local setup):
+
+```bash
+git clone https://github.com/QuantJourneyOrg/qj_bidask
+cd qj_bidask
+pip install -e .
+```
+
 ## Quick Start
 
 ### Basic Usage
@@ -89,42 +101,106 @@ print(f"Estimated bid-ask spread: {spread:.6f}")
 
 ```python
 from quantjourney_bidask import edge_rolling
+import pandas as pd
+
+# Create DataFrame with OHLC data
+df = pd.DataFrame({
+    'open': open_prices,
+    'high': high_prices,
+    'low': low_prices,
+    'close': close_prices
+})
 
 # Calculate rolling spreads with a 20-period window
-rolling_spreads = edge_rolling(
-    open_prices, high_prices, low_prices, close_prices, 
-    window=20
-)
+rolling_spreads = edge_rolling(df, window=20)
 print(f"Rolling spreads: {rolling_spreads}")
 ```
 
 ### Data Fetching Integration
 
 ```python
-from quantjourney_bidask import fetch_yfinance_data, edge
+from data.fetch import get_stock_data, get_crypto_data
+from quantjourney_bidask import edge_rolling
+import asyncio
+
+# Fetch stock data
+stock_df = get_stock_data("AAPL", period="1mo", interval="1d")
+stock_spreads = edge_rolling(stock_df, window=20)
+print(f"AAPL average spread: {stock_spreads.mean():.6f}")
+
+# Fetch crypto data (async)
+async def get_crypto_spreads():
+    crypto_df = await get_crypto_data("BTC/USDT", "binance", "1h", 168)
+    crypto_spreads = edge_rolling(crypto_df, window=24)
+    return crypto_spreads.mean()
+
+crypto_avg_spread = asyncio.run(get_crypto_spreads())
+print(f"BTC average spread: {crypto_avg_spread:.6f}")
+```
+
+### Real-time Data Streaming
+
+```python
+from data.fetch import DataFetcher
+import asyncio
+
+async def stream_btc_spreads():
+    fetcher = DataFetcher()
+    # Stream BTC data for 60 seconds
+    btc_stream = await fetcher.get_btc_1m_websocket(duration_seconds=60)
+    
+    # Calculate spread from real-time data
+    if not btc_stream.empty:
+        avg_spread_pct = (btc_stream['spread'] / btc_stream['price']).mean() * 100
+        print(f"Real-time BTC average spread: {avg_spread_pct:.4f}%")
+
+asyncio.run(stream_btc_spreads())
+```
+
+### Real-Time Spread Monitoring
+
+```python
+from data.fetch import create_spread_monitor
 
-# Fetch OHLC data for a stock
-data = fetch_yfinance_data("AAPL", period="1mo", interval="1h")
+# Create real-time spread monitor
+monitor = create_spread_monitor(["BTCUSDT", "ETHUSDT"], window=20)
 
-# Calculate spread from fetched data
-spread = edge(data['Open'], data['High'], data['Low'], data['Close'])
-print(f"AAPL spread estimate: {spread:.6f}")
+# Add callback for spread updates
+def print_spread_update(spread_data):
+    print(f"{spread_data['symbol']}: {spread_data['spread_bps']:.2f} bps")
+
+monitor.add_spread_callback(print_spread_update)
+
+# Start monitoring (uses websockets for live data)
+monitor.start_monitoring("1m")
 ```
 
-### Live Monitoring
+### Animated Real-Time Dashboard
 
 ```python
-from quantjourney_bidask import LiveSpreadMonitor
+# Run the real-time dashboard
+python examples/realtime_spread_monitor.py --mode dashboard
+
+# Or console mode
+python examples/realtime_spread_monitor.py --mode console
+```
+
+## Examples
 
-# Monitor live spreads for cryptocurrency
-monitor = LiveSpreadMonitor("BTCUSDT", window=100)
-monitor.start()
+The `examples/` directory contains comprehensive examples:
 
-# Get current spread estimate
-current_spread = monitor.get_current_spread()
-print(f"Current BTC/USDT spread: {current_spread:.6f}")
+- `spread_estimator.py` - Basic spread estimation examples
+- `spread_monitor.py` - Spread monitoring with threshold alerts
+- `realtime_spread_monitor.py` - Live websocket monitoring with animation
+- `crypto_spread_comparison.py` - Multi-asset spread comparison
+- `liquidity_risk_monitor.py` - Liquidity risk monitoring
+- `stock_liquidity_risk.py` - Stock-specific liquidity analysis
 
-monitor.stop()
+Run any example:
+
+```bash
+python examples/spread_estimator.py
+python examples/realtime_spread_monitor.py
 ```
 
 ## API Reference
@@ -132,25 +208,45 @@ monitor.stop()
 ### Core Functions
 
 - `edge(open, high, low, close, sign=False)`: Single-period spread estimation
-- `edge_rolling(open, high, low, close, window, min_periods=None)`: Rolling window estimation
-- `edge_expanding(open, high, low, close, min_periods=3)`: Expanding window estimation
+- `edge_rolling(df, window, min_periods=None)`: Rolling window estimation  
+- `edge_expanding(df, min_periods=3)`: Expanding window estimation
 
-### Data Fetching
+### Data Fetching (`data/fetch.py`)
 
-- `fetch_yfinance_data(symbol, period, interval)`: Fetch data from Yahoo Finance
-- `fetch_binance_data(symbol, interval, limit)`: Fetch data from Binance API
+- `fetch_yfinance_data(tickers, period, interval)`: Fetch real market data from Yahoo Finance
+- `generate_synthetic_crypto_data(symbols, hours, interval_minutes)`: Generate synthetic crypto data
+- `fetch_binance_data(*args, **kwargs)`: Compatibility function (returns synthetic data)
+- `create_realtime_stream(symbols, exchange)`: Create websocket data stream
+- `create_spread_monitor(symbols, window)`: Create real-time spread monitor
 
-### Live Monitoring
+### Real-Time Classes
 
-- `LiveSpreadMonitor(symbol, window)`: Real-time spread monitoring via WebSocket
+- `RealTimeDataStream`: Websocket data streaming for live market data
+- `RealTimeSpreadMonitor`: Real-time spread calculation and monitoring
+- `AnimatedSpreadMonitor`: Animated real-time visualization
 
 ## Requirements
 
-- Python >= 3.8
+- Python >= 3.11
 - numpy >= 1.20
 - pandas >= 1.5
 - requests >= 2.28
 - yfinance >= 0.2
+- matplotlib >= 3.5
+- websocket-client >= 1.0
+
+## WebSocket Support
+
+The library supports real-time data via websockets:
+
+- **Binance**: `wss://stream.binance.com:9443/ws/` (cryptocurrency data)
+- **Fallback**: Synthetic data generation for testing when websockets unavailable
+
+Real-time features:
+- Live spread calculation
+- Animated visualizations
+- Threshold alerts
+- Multi-symbol monitoring
 
 ## Academic Citation
 
@@ -176,6 +272,20 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 
 Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
 
+### Development Setup
+
+```bash
+git clone https://github.com/QuantJourneyOrg/qj_bidask
+cd qj_bidask
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Run examples
+python examples/realtime_spread_monitor.py
+```
+
 ## Support
 
 - **Documentation**: [GitHub Repository](https://github.com/QuantJourneyOrg/qj_bidask)

{quantjourney_bidask-0.5.0.dist-info → quantjourney_bidask-0.6.0.dist-info}/RECORD

@@ -1,12 +1,12 @@
 quantjourney_bidask/__init__.py,sha256=vumoRDEDOTclYapknfSwKpCZi9IdfJbukdp7S1-kphA,409
-quantjourney_bidask/_version.py,sha256=FG3XKw_Vb0JfvroFMn303BEuhI10eKAvkGzI0gQT-LY,235
+quantjourney_bidask/_version.py,sha256=kyNk5HYKJ0-OI9dXUspkUZDOPfOl8yymKmhaJH3QWcU,235
 quantjourney_bidask/data_fetcher.py,sha256=GMVf4wRVwIE2JJ2sYAR_CCo56JQnReNhTWTSrZc0-L0,4931
 quantjourney_bidask/edge.py,sha256=z-uRUH3Rot6Zw-dPa2pNlQu0hY1YJu6d0c18IyqbiNs,6105
 quantjourney_bidask/edge_expanding.py,sha256=bN6lBetJdqC2xSdRc1RTjHfSI1XXVKegl0GQaD8eanY,2047
 quantjourney_bidask/edge_rolling.py,sha256=CAZW_wBF7G6mGLenoEwlq4yB_1x1-PsQ4TgwL-zdM7w,8910
 quantjourney_bidask/websocket_fetcher.py,sha256=xMS_qLbSW9hCS3RbNKvkn5HTK0XGmAO4wpaAl4_Mxb4,10895
-quantjourney_bidask-0.5.0.dist-info/licenses/LICENSE,sha256=vny3AM3KIslUu5fdooMsdxVKghoZhDKnBCsLvMDHqLg,1081
-quantjourney_bidask-0.5.0.dist-info/METADATA,sha256=17qESjK2WZZl89pukiZF21IzX4xlbP_n14lZWNsfDbg,6234
-quantjourney_bidask-0.5.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-quantjourney_bidask-0.5.0.dist-info/top_level.txt,sha256=rOBM4GxA87iQv-mR8-WZdu3-Yj5ESyggRICpUhJ-4Dg,20
-quantjourney_bidask-0.5.0.dist-info/RECORD,,
+quantjourney_bidask-0.6.0.dist-info/licenses/LICENSE,sha256=vny3AM3KIslUu5fdooMsdxVKghoZhDKnBCsLvMDHqLg,1081
+quantjourney_bidask-0.6.0.dist-info/METADATA,sha256=mznMm67-LzniXtsOHzxwdvlLFJnKXnbwiGaSDjBcIMU,9565
+quantjourney_bidask-0.6.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+quantjourney_bidask-0.6.0.dist-info/top_level.txt,sha256=rOBM4GxA87iQv-mR8-WZdu3-Yj5ESyggRICpUhJ-4Dg,20
+quantjourney_bidask-0.6.0.dist-info/RECORD,,