forex_data Logo

User Guide

  • Installation
    • Prerequisites
      • Installing Poetry
    • Quick Installation
      • Using pip or Poetry (Recommended)
    • Installing from Source
      • For Development or Latest Features
        • 1. Clone the Repository
        • 2. Install Poetry
        • 3. Install Dependencies
        • 4. Verify Installation
      • Alternative: Using pip from Source
    • Installation Options
      • Development Installation
      • Minimal Installation
    • Requirements
    • Next Steps
  • Quick Start
    • Basic Concepts
    • Configuration
    • Working with Historical Data
      • Basic Usage
      • Changing Timeframes
      • Adding Custom Timeframes
      • Visualizing Data
    • Working with Real-time Data
      • Basic Usage
      • Get Latest Close Price
      • Get Recent History
      • Get Intraday Data
    • Complete Example
    • Data Engine Selection
      • Polars (Recommended)
      • PyArrow
      • Pandas
    • Next Steps
    • Need Help?
  • Configuration
    • Configuration File
      • Basic Configuration File
    • Configuration Options
      • ENGINE
      • DATA_FILETYPE
      • DATA_PATH
      • PROVIDERS_KEY
        • Getting API Keys
    • Using Configuration in Code
      • Specify Configuration File folder
      • Explicit Configuration File
      • Overriding Configuration
    • Advanced Configuration
      • Template Configuration File
      • Environment Variables
    • Configuration Best Practices
    • Example: Production Configuration
    • Troubleshooting
      • Configuration Not Found
      • Invalid API Key
    • Next Steps
  • Examples
    • Historical Data Examples
      • Example 1: Basic Data Retrieval
      • Example 2: Working with Multiple Timeframes
      • Example 3: Visualizing Historical Data
      • Example 4: Multi-Year Analysis
      • Example 5: Conditional Data Filtering
    • Real-time Data Examples
      • Example 5: Get Latest Market Price
      • Example 6: Recent Price History
      • Example 7: Specific Date Range (Real-time)
      • Example 8: Intraday Real-time Data
    • Combined Examples
      • Example 9: Historical + Real-time Combination
      • Example 10: Multi-Currency Analysis
    • Advanced Examples
      • Example 11: Custom Data Processing Pipeline
      • Example 12: Error Handling and Validation
      • Example 13: Performance Optimization
      • Example 14: Export to Different Formats
    • Testing Examples
      • Example 15: Running the Test Suite
    • Tips and Best Practices
    • Next Steps

API Reference

  • forex_data
    • forex_data_aggregator package
      • Subpackages
        • forex_data.config package
        • forex_data.data_management package
      • Module contents
        • read_config_file()
        • read_config_string()
        • read_config_folder()
        • HistoricalManagerDB
        • BASE_DATA_COLUMN_NAME
        • DATA_FILE_COLUMN_INDEX
        • DEFAULT_PATHS
        • SQL_COMPARISON_OPERATORS
        • SQL_CONDITION_AGGREGATION_MODES
        • empty_dataframe()
        • is_empty_dataframe()
        • shape_dataframe()
        • get_dataframe_column()
        • get_dataframe_row()
        • get_dataframe_element()
        • get_attrs_names()
        • any_date_to_datetime64()
        • get_db_key_elements()
        • check_timeframe_str()
        • DatabaseConnector
        • LocalDBConnector
        • RealTimeDBConnectorTwelveData
        • DukascopyConnector
        • concat_data()
        • validator_dir_path()
        • TickerNotFoundError
        • TickerDataNotFoundError
        • TickerDataBadTypeException
        • TickerDataInvalidException
        • get_histdata_tickers()
        • POLARS_DTYPE_DICT
        • business_days_data()
        • random_date_between()

Additional Information

  • Contributing
    • Getting Started
      • Development Setup
    • Code Standards
      • Python Style Guide
      • Linting and Formatting
    • Testing
      • Writing Tests
      • Running Tests
      • Continuous Integration
    • Documentation
      • Building Documentation
      • Docstring Format
      • Adding Documentation Pages
    • Contribution Workflow
      • Making Changes
      • Submitting a Pull Request
    • What to Contribute
      • Features
      • Bug Fixes
      • Documentation
      • Tests
    • Development Priorities
      • Current Focus Areas
    • Code Review Process
      • What Reviewers Look For
    • Getting Help
    • Community Guidelines
      • Be Respectful
      • Code of Conduct
    • License
    • Recognition
    • Thank You!
  • Changelog
    • Version 0.2.0 (Current)
      • Added
        • Core Features
        • Data Management
        • Developer Experience
        • Documentation
      • Known Issues
    • Future Releases
      • Planned for v0.3.0
      • Planned for v0.4.0
    • How to Upgrade
    • Contributing to Changelog
    • See Also
forex_data
  • Python Module Index

Python Module Index

f
 
f
- forex_data
    forex_data.config
    forex_data.config.config_file
    forex_data.data_management
    forex_data.data_management.common
    forex_data.data_management.database
    forex_data.data_management.historicaldata

© Copyright 2024, Nicola Fiorato.

Built with Sphinx using a theme provided by Read the Docs.