zerodha-data-fetcher 1.0.0__tar.gz

zerodha_data_fetcher-1.0.0/MANIFEST.in

@@ -0,0 +1,9 @@
+include README.md
+include LICENSE
+include pyproject.toml
+include setup.py
+recursive-include src/zerodha_data_fetcher *.py
+recursive-include src/zerodha_data_fetcher/utils/data *.csv
+recursive-include src/zerodha_data_fetcher/utils/data *.json
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]

zerodha_data_fetcher-1.0.0/PKG-INFO

@@ -0,0 +1,209 @@
+Metadata-Version: 2.4
+Name: zerodha-data-fetcher
+Version: 1.0.0
+Summary: A Python package for fetching historical data from Zerodha API
+Author-email: Jayam Gupta <guptajayam47@gmail.com>
+Maintainer-email: Jayam Gupta <guptajayam47@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/JayceeGupta/Zerodha-Data-Fetcher
+Project-URL: Repository, https://github.com/JayceeGupta/Zerodha-Data-Fetcher
+Project-URL: Documentation, https://github.com/JayceeGupta/Zerodha-Data-Fetcher#readme
+Project-URL: Bug Tracker, https://github.com/JayceeGupta/Zerodha-Data-Fetcher/issues
+Keywords: zerodha,trading,data,api,historical,stock-market
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.25.0
+Requires-Dist: pandas>=1.3.0
+Requires-Dist: python-dateutil>=2.8.0
+Requires-Dist: pyotp>=2.6.0
+Requires-Dist: keyring>=23.0.0
+Requires-Dist: cryptography>=3.4.0
+Requires-Dist: Brotli>=1.0.9
+Provides-Extra: dev
+Requires-Dist: pytest>=6.0; extra == "dev"
+Requires-Dist: pytest-cov>=2.0; extra == "dev"
+Requires-Dist: black>=21.0; extra == "dev"
+Requires-Dist: flake8>=3.9; extra == "dev"
+Requires-Dist: mypy>=0.910; extra == "dev"
+Requires-Dist: pre-commit>=2.15; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx>=4.0; extra == "docs"
+Requires-Dist: sphinx-rtd-theme>=1.0; extra == "docs"
+Requires-Dist: myst-parser>=0.15; extra == "docs"
+Dynamic: license-file
+
+# Zerodha Data Fetcher
+
+A Python package for fetching historical data from Zerodha API with advanced features like rate limiting, authentication management, and parallel data fetching.
+
+## Features
+
+- 🚀 **Fast Parallel Data Fetching**: Concurrent requests with intelligent rate limiting
+- 🔐 **Automatic Authentication**: Handles login, 2FA, and token management
+- 📊 **Multiple Data Formats**: Support for minute, daily, and other timeframes
+- 🛡️ **Error Handling**: Robust error handling with retry mechanisms
+- 🔍 **Symbol Search**: Built-in instrument search and validation
+- ⚙️ **Configurable**: Flexible configuration via environment variables or parameters
+
+## Installation
+
+```bash
+pip install zerodha-data-fetcher
+```
+
+## Quick Start
+
+### 1. Set up environment variables
+
+Create a `.env` file in your project root:
+
+```env
+ZERODHA_USER_ID=your_user_id
+ZERODHA_PASSWORD=your_password
+ZERODHA_USER_TYPE=individual
+ZERODHA_TOTP_SECRET=your_totp_secret
+```
+
+### 2. Basic Usage
+
+```python
+from zerodha_data_fetcher import ZerodhaDataFetcher
+from datetime import date, timedelta
+
+# Initialize the fetcher
+fetcher = ZerodhaDataFetcher(requests_per_second=2)
+
+# Fetch historical data
+end_date = date.today()
+start_date = end_date - timedelta(days=30)
+
+# Using symbol (recommended)
+data = fetcher.fetch_historical_data(
+    ticker_token="RELIANCE",
+    start_date=start_date,
+    end_date=end_date,
+    timeframe="minute"
+)
+
+# Using instrument token
+data = fetcher.fetch_historical_data(
+    ticker_token=408065,  # HDFC Bank
+    start_date=start_date,
+    end_date=end_date,
+    timeframe="minute"
+)
+
+print(data.head())
+```
+
+### 3. Advanced Usage
+
+```python
+# Custom configuration
+fetcher = ZerodhaDataFetcher(
+    requests_per_second=3,
+    token_expiry_hours=6,
+    user_id="custom_user_id",  # Override env var
+    password="custom_password"  # Override env var
+)
+
+# Search for symbols
+results = fetcher.search_symbols("HDFC", limit=5)
+print(results)
+
+# Get instrument info
+info = fetcher.get_instrument_info("RELIANCE")
+print(info)
+```
+
+## Configuration
+
+### Environment Variables
+
+| Variable                           | Description                         | Required |
+| ---------------------------------- | ----------------------------------- | -------- |
+| `ZERODHA_USER_ID`                | Your Zerodha user ID                | Yes      |
+| `ZERODHA_PASSWORD`               | Your Zerodha password               | Yes      |
+| `ZERODHA_USER_TYPE`              | Account type (individual/corporate) | Yes      |
+| `ZERODHA_TOTP_SECRET`            | TOTP secret for 2FA                 | Yes      |
+| `ZERODHA_KEYRING_TOKEN_KEY`      | Keyring token key                   | No       |
+| `ZERODHA_KEYRING_ENCRYPTION_KEY` | Keyring encryption key              | No       |
+
+### Parameters
+
+- `requests_per_second`: API rate limit (1-10, default: 2)
+- `token_expiry_hours`: Token validity period (default: 6)
+- `timeframe`: Data timeframe ('minute', 'day', etc.)
+
+## API Reference
+
+### ZerodhaDataFetcher
+
+Main class for fetching historical data.
+
+#### Methods
+
+- `fetch_historical_data(ticker_token, start_date, end_date, timeframe='minute')`: Fetch historical data
+- `search_symbols(partial_name, limit=10)`: Search for trading symbols
+- `get_instrument_info(symbol)`: Get instrument information
+
+## Error Handling
+
+The package includes comprehensive error handling:
+
+```python
+from zerodha_data_fetcher.utils.exceptions import (
+    ZerodhaAPIError,
+    AuthenticationError,
+    InvalidTickerError,
+    DataFetchError
+)
+
+try:
+    data = fetcher.fetch_historical_data("INVALID", start_date, end_date)
+except InvalidTickerError as e:
+    print(f"Invalid ticker: {e}")
+except AuthenticationError as e:
+    print(f"Auth failed: {e}")
+except DataFetchError as e:
+    print(f"Data fetch failed: {e}")
+```
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Add tests
+5. Submit a pull request
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Disclaimer
+
+This package is for educational and research purposes. Please ensure compliance with Zerodha's terms of service and applicable regulations when using this package.
+
+## Support
+
+- 📖 [Documentation](https://github.com/JayceeGupta/Zerodha-Data-Fetcher#readme)
+- 🐛 [Bug Reports](https://github.com/JayceeGupta/Zerodha-Data-Fetcher/issues)
+- 💬 [Discussions](https://github.com/JayceeGupta/Zerodha-Data-Fetcher/discussions)
+
+```
+
+```

zerodha_data_fetcher-1.0.0/README.md

@@ -0,0 +1,162 @@
+# Zerodha Data Fetcher
+
+A Python package for fetching historical data from Zerodha API with advanced features like rate limiting, authentication management, and parallel data fetching.
+
+## Features
+
+- 🚀 **Fast Parallel Data Fetching**: Concurrent requests with intelligent rate limiting
+- 🔐 **Automatic Authentication**: Handles login, 2FA, and token management
+- 📊 **Multiple Data Formats**: Support for minute, daily, and other timeframes
+- 🛡️ **Error Handling**: Robust error handling with retry mechanisms
+- 🔍 **Symbol Search**: Built-in instrument search and validation
+- ⚙️ **Configurable**: Flexible configuration via environment variables or parameters
+
+## Installation
+
+```bash
+pip install zerodha-data-fetcher
+```
+
+## Quick Start
+
+### 1. Set up environment variables
+
+Create a `.env` file in your project root:
+
+```env
+ZERODHA_USER_ID=your_user_id
+ZERODHA_PASSWORD=your_password
+ZERODHA_USER_TYPE=individual
+ZERODHA_TOTP_SECRET=your_totp_secret
+```
+
+### 2. Basic Usage
+
+```python
+from zerodha_data_fetcher import ZerodhaDataFetcher
+from datetime import date, timedelta
+
+# Initialize the fetcher
+fetcher = ZerodhaDataFetcher(requests_per_second=2)
+
+# Fetch historical data
+end_date = date.today()
+start_date = end_date - timedelta(days=30)
+
+# Using symbol (recommended)
+data = fetcher.fetch_historical_data(
+    ticker_token="RELIANCE",
+    start_date=start_date,
+    end_date=end_date,
+    timeframe="minute"
+)
+
+# Using instrument token
+data = fetcher.fetch_historical_data(
+    ticker_token=408065,  # HDFC Bank
+    start_date=start_date,
+    end_date=end_date,
+    timeframe="minute"
+)
+
+print(data.head())
+```
+
+### 3. Advanced Usage
+
+```python
+# Custom configuration
+fetcher = ZerodhaDataFetcher(
+    requests_per_second=3,
+    token_expiry_hours=6,
+    user_id="custom_user_id",  # Override env var
+    password="custom_password"  # Override env var
+)
+
+# Search for symbols
+results = fetcher.search_symbols("HDFC", limit=5)
+print(results)
+
+# Get instrument info
+info = fetcher.get_instrument_info("RELIANCE")
+print(info)
+```
+
+## Configuration
+
+### Environment Variables
+
+| Variable                           | Description                         | Required |
+| ---------------------------------- | ----------------------------------- | -------- |
+| `ZERODHA_USER_ID`                | Your Zerodha user ID                | Yes      |
+| `ZERODHA_PASSWORD`               | Your Zerodha password               | Yes      |
+| `ZERODHA_USER_TYPE`              | Account type (individual/corporate) | Yes      |
+| `ZERODHA_TOTP_SECRET`            | TOTP secret for 2FA                 | Yes      |
+| `ZERODHA_KEYRING_TOKEN_KEY`      | Keyring token key                   | No       |
+| `ZERODHA_KEYRING_ENCRYPTION_KEY` | Keyring encryption key              | No       |
+
+### Parameters
+
+- `requests_per_second`: API rate limit (1-10, default: 2)
+- `token_expiry_hours`: Token validity period (default: 6)
+- `timeframe`: Data timeframe ('minute', 'day', etc.)
+
+## API Reference
+
+### ZerodhaDataFetcher
+
+Main class for fetching historical data.
+
+#### Methods
+
+- `fetch_historical_data(ticker_token, start_date, end_date, timeframe='minute')`: Fetch historical data
+- `search_symbols(partial_name, limit=10)`: Search for trading symbols
+- `get_instrument_info(symbol)`: Get instrument information
+
+## Error Handling
+
+The package includes comprehensive error handling:
+
+```python
+from zerodha_data_fetcher.utils.exceptions import (
+    ZerodhaAPIError,
+    AuthenticationError,
+    InvalidTickerError,
+    DataFetchError
+)
+
+try:
+    data = fetcher.fetch_historical_data("INVALID", start_date, end_date)
+except InvalidTickerError as e:
+    print(f"Invalid ticker: {e}")
+except AuthenticationError as e:
+    print(f"Auth failed: {e}")
+except DataFetchError as e:
+    print(f"Data fetch failed: {e}")
+```
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Add tests
+5. Submit a pull request
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Disclaimer
+
+This package is for educational and research purposes. Please ensure compliance with Zerodha's terms of service and applicable regulations when using this package.
+
+## Support
+
+- 📖 [Documentation](https://github.com/JayceeGupta/Zerodha-Data-Fetcher#readme)
+- 🐛 [Bug Reports](https://github.com/JayceeGupta/Zerodha-Data-Fetcher/issues)
+- 💬 [Discussions](https://github.com/JayceeGupta/Zerodha-Data-Fetcher/discussions)
+
+```
+
+```

zerodha_data_fetcher-1.0.0/pyproject.toml

@@ -0,0 +1,87 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "zerodha-data-fetcher"
+version = "1.0.0"
+description = "A Python package for fetching historical data from Zerodha API"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [
+    {name = "Jayam Gupta", email = "guptajayam47@gmail.com"}
+]
+maintainers = [
+    {name = "Jayam Gupta", email = "guptajayam47@gmail.com"}
+]
+keywords = ["zerodha", "trading", "data", "api", "historical", "stock-market"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Financial and Insurance Industry",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Office/Business :: Financial",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+requires-python = ">=3.8"
+dependencies = [
+    "requests>=2.25.0",
+    "pandas>=1.3.0",
+    "python-dateutil>=2.8.0",
+    "pyotp>=2.6.0",
+    "keyring>=23.0.0",
+    "cryptography>=3.4.0",
+    "Brotli>=1.0.9",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=6.0",
+    "pytest-cov>=2.0",
+    "black>=21.0",
+    "flake8>=3.9",
+    "mypy>=0.910",
+    "pre-commit>=2.15",
+]
+docs = [
+    "sphinx>=4.0",
+    "sphinx-rtd-theme>=1.0",
+    "myst-parser>=0.15",
+]
+
+[project.urls]
+Homepage = "https://github.com/JayceeGupta/Zerodha-Data-Fetcher"
+Repository = "https://github.com/JayceeGupta/Zerodha-Data-Fetcher"
+Documentation = "https://github.com/JayceeGupta/Zerodha-Data-Fetcher#readme"
+"Bug Tracker" = "https://github.com/JayceeGupta/Zerodha-Data-Fetcher/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+zerodha_data_fetcher = ["utils/data/*.csv", "utils/data/*.json"]
+
+[tool.black]
+line-length = 88
+target-version = ['py38']
+include = '\.pyi?$'
+
+[tool.mypy]
+python_version = "3.8"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]
+addopts = "-v --cov=zerodha_data_fetcher --cov-report=html --cov-report=term-missing"

zerodha_data_fetcher-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

zerodha_data_fetcher-1.0.0/setup.py

@@ -0,0 +1,6 @@
+"""Setup script for zerodha-data-fetcher package."""
+
+from setuptools import setup
+
+# Use pyproject.toml for configuration
+setup()

zerodha_data_fetcher-1.0.0/src/zerodha_data_fetcher/__init__.py

@@ -0,0 +1,24 @@
+"""Zerodha Data Fetcher - A Python package for fetching historical data from Zerodha API."""
+
+__version__ = "1.0.0"
+__author__ = "Your Name"
+__email__ = "your.email@example.com"
+
+# Import main classes and functions for easy access
+try:
+    from .core.data_fetcher import ZerodhaDataFetcher, fetchDataZerodha
+    from .utils.logging_config import setup_logging
+    from .utils.config import Config
+    
+    __all__ = [
+        "ZerodhaDataFetcher",
+        "fetchDataZerodha", 
+        "setup_logging",
+        "Config",
+        "__version__"
+    ]
+except ImportError as e:
+    # Handle import errors gracefully during development
+    import warnings
+    warnings.warn(f"Some imports failed: {e}")
+    __all__ = ["__version__"]

zerodha_data_fetcher-1.0.0/src/zerodha_data_fetcher/core/__init__.py

@@ -0,0 +1,43 @@
+# """Core functionality for Zerodha Data Fetcher."""
+
+# from .data_fetcher import ZerodhaDataFetcher
+# from .auth import AuthenticationManager
+# from .token_generator import ZerodhaTokenGenerator, getEncAuthToken, get_TOTP
+# from .instrument_manager import ZerodhaInstrumentManager, fetchZerodhaID
+# from .rate_limiter import RateLimitedThreadPoolExecutor
+
+# __all__ = [
+#     "ZerodhaDataFetcher",
+#     "AuthenticationManager", 
+#     "ZerodhaTokenGenerator",
+#     "ZerodhaInstrumentManager",
+#     "RateLimitedThreadPoolExecutor",
+#     "getEncAuthToken",  # Backward compatibility
+#     "get_TOTP",         # Backward compatibility
+#     "fetchZerodhaID"    # Backward compatibility
+# ]
+
+
+"""
+Core modules for Zerodha Data Fetcher.
+
+This module contains the main functionality:
+- Data fetching and processing
+- Authentication management  
+- Rate limiting
+- Instrument management
+"""
+
+from .data_fetcher import ZerodhaDataFetcher, fetchDataZerodha
+from .instrument_manager import ZerodhaInstrumentManager, fetchZerodhaID
+from .auth import AuthenticationManager
+from .rate_limiter import RateLimitedThreadPoolExecutor
+
+__all__ = [
+    "ZerodhaDataFetcher",
+    "fetchDataZerodha", 
+    "ZerodhaInstrumentManager",
+    "fetchZerodhaID",
+    "AuthenticationManager",
+    "RateLimitedThreadPoolExecutor",
+]

zerodha_data_fetcher-1.0.0/src/zerodha_data_fetcher/core/auth.py

@@ -0,0 +1,101 @@
+"""Authentication management for Zerodha API."""
+
+import os
+import time
+import logging
+from datetime import date
+from typing import Optional
+
+import keyring
+
+from ..utils.config import Config
+from ..utils.exceptions import AuthenticationError, TokenExpiredError
+from ..utils.encryption import TokenEncryption
+from .token_generator import ZerodhaTokenGenerator
+
+logger = logging.getLogger(__name__)
+
+
+class AuthenticationManager:
+    """Manages authentication tokens for Zerodha API."""
+    
+    def __init__(self, token_expiry_hours: float = Config.DEFAULT_TOKEN_EXPIRY_HOURS, config: Optional['Config'] = None):
+        self.token_expiry_hours = token_expiry_hours
+        self.config = config or Config()
+        self.token_key = self.config.ZERODHA_KEYRING_TOKEN_KEY
+        self.token_generator = ZerodhaTokenGenerator(config=self.config)
+
+    def get_auth_token(self) -> str:
+        """
+        Retrieves an authentication token for accessing the Zerodha API.
+        
+        Returns:
+            str: The authentication token.
+            
+        Raises:
+            AuthenticationError: If token generation fails.
+        """
+        try:
+            expiry_seconds = self.token_expiry_hours * 3600
+            today = date.today().strftime('%Y-%m-%d')
+            current_time = time.time()
+            
+            logger.debug(f"Getting auth token for date: {today}")
+            
+            # Try to retrieve stored token
+            encrypted_token = keyring.get_password(self.token_key, "token")
+            token_date = keyring.get_password(self.token_key, "date")
+            token_timestamp = keyring.get_password(self.token_key, "timestamp")
+            
+            if encrypted_token and token_date and token_timestamp:
+                logger.info("Found token data in keyring")
+                time_elapsed = current_time - float(token_timestamp)
+                logger.info(f"Time elapsed since last token: {time_elapsed} seconds")
+                logger.info(f"Token expiry time: {expiry_seconds} seconds")
+                if token_date == today and time_elapsed < expiry_seconds:
+                    logger.info("Found valid token for today")
+                    return TokenEncryption.decrypt_token(encrypted_token)
+                else:
+                    logger.debug("Stored token is outdated")
+            else:
+                logger.debug("No valid token data found in keyring")
+                
+        except Exception as e:
+            logger.error(f"Error retrieving token: {str(e)}")
+            
+        # Generate new token
+        return self._generate_new_token()
+    
+    def _generate_new_token(self) -> str:
+        """Generate and store a new authentication token."""
+        logger.info("Generating new auth token")
+        
+        try:
+            new_token = self.token_generator.generate_auth_token()
+            encrypted_token = TokenEncryption.encrypt_token(new_token)
+                
+            # Store the new token
+            today = date.today().strftime('%Y-%m-%d')
+            current_time = time.time()
+            
+            keyring.set_password(self.token_key, "token", encrypted_token)
+            keyring.set_password(self.token_key, "date", today)
+            keyring.set_password(self.token_key, "timestamp", str(current_time))
+            keyring.set_password(self.token_key, "userid", self.config.get_user_id())
+            
+            logger.info("Successfully saved new token to keyring")
+            return new_token
+            
+        except Exception as e:
+            logger.error(f"Failed to generate/save token: {str(e)}")
+            raise AuthenticationError(f"Token generation failed: {str(e)}")
+    
+    def invalidate_token(self) -> None:
+        """Invalidate the current stored token."""
+        try:
+            keyring.delete_password(self.token_key, "token")
+            keyring.delete_password(self.token_key, "date") 
+            keyring.delete_password(self.token_key, "timestamp")
+            logger.info("Token invalidated successfully")
+        except Exception as e:
+            logger.warning(f"Failed to invalidate token: {str(e)}")