A CLI app to fetch financial data and analys.
- Python 3.11
- Git (optional, for cloning the repository)
-
Clone the repository (if using Git):
git clone https://github.com/asmdhabibullah/findrl.git cd findrl -
Download the repository (if not using Git):
Download the ZIP file from the repository, extract it, and navigate to the project directory.
-
Create a
.envfile in the root directory with your API keys:ALPHA_VANTAGE_API_KEY=your_alpha_vantage_api_key POLYGON_API_KEY=your_polygon_api_key
-
Run the setup script:
chmod +x setup.sh ./setup.sh
This script will check your Python version, create
requirements.txtif it does not exist, create a virtual environment, activate it, and install the required dependencies.
-
Activate the virtual environment:
-
On Linux/macOS:
source venv/bin/activate -
On Windows:
venv\Scripts\activate
-
-
Run the CLI command:
fetch-data SYMBOL --start-date YYYY-MM-DD --end-date YYYY-MM-DD
Replace
SYMBOLwith the stock symbol, and provide the appropriate start and end dates.
This project is licensed under the MIT License.
### Steps to Run the Setup
1. **Clone the Repository** (if using Git):
```bash
git clone https://github.com/yourusername/your_project.git
cd your_project
-
Download the Repository (if not using Git):
Download the ZIP file from the repository, extract it, and navigate to the project directory.
-
Create the
.envFile:Create a
.envfile in the root directory with your API keys:ALPHA_VANTAGE_API_KEY=your_alpha_vantage_api_key POLYGON_API_KEY=your_polygon_api_key
-
Run the Setup Script:
chmod +x setup.sh ./setup.sh
-
Activate the Virtual Environment:
-
On Linux/macOS:
source venv/bin/activate -
On Windows:
venv\Scripts\activate
-
-
Run the CLI Command:
fetch-data SYMBOL --start-date YYYY-MM-DD --end-date YYYY-MM-DD
Replace SYMBOL with the stock symbol, and provide the appropriate start and end dates.