How rahul-d-rao/mutual_fund_tracker works
Project Type & Purpose
• This is a data processing and integration application designed to ingest mutual fund data via CSV, process and transform the data (e.g., filtering, grouping, aggregating), and then export results and interact with AWS services.
• The project integrates with AWS S3 (for storing CSV outputs) and AWS Bedrock (for leveraging generative AI to summarize performance data).
Main Components
a. Data Input Component:
• Datasets folder (with input CSV files) as the starting point where raw mutual fund data is stored.
b. Data Processing Module:
• “data_processing” module in src including components such as:
• load_data.py – responsible for loading input CSV files.
• transform_data_and_filter.py, data_range_filter.py, group_by_fund.py, export_results.py – which process, filter, and group the data.
c. Core Application Entry Points:
d. Services Integration:
• A module for “services” containing:
• aws_s3_service.py – for interfacing with AWS S3 (uploading files).
• aws_bedrock_service.py – for interacting with AWS Bedrock to summarize mutual fund performance.
• logger.py – for capturing and recording application events.
e. Command Line Interface (CLI):
• CLI module under src/cli (e.g., cli_helpers.py). It indicates how users interact with the system via command-line commands.
f. Configuration Management:
• Configuration files (config.yaml, aws_credentials.json, and logging_config.json) which provide data file paths, AWS credentials, and log settings.
g. Testing Suite:
• Optionally, add a block for the tests folder to show the unit tests ensuring reliability for AWS services, CLI functionality, and data processing.
Relationships and Interactions
• Data flows from the “datasets” folder (Input CSV) to the data processing components.
• The data processing modules (loading, filtering, grouping, transformation) feed into the export module.
• The CLI acts as a triggering interface (starting point) which then channels requests to the processing modules.
• Dependency on configuration files and environment setup to drive these interactions.
Architectural Patterns and Design Principles
• Modular Structure: Separate directories for data processing, service integration, and CLI indicate a modular architecture.
• Configuration-driven Design: External configuration files drive input/output paths and AWS credentials.
• Third-Party Service Integration: Emphasize the AWS SDK (Boto3) usage for AWS S3 and AWS Bedrock interactions.