16 lines
510 B
Markdown
16 lines
510 B
Markdown
# My Stock Screener
|
|
|
|
## Overview
|
|
This repository contains a Python-based stock screener that evaluates multiple metrics on a set of stocks, assigns a score, and outputs a CSV of the results.
|
|
|
|
## Project Structure
|
|
- **src/** contains the main application code.
|
|
- **data/** is where you can store raw input data; it is ignored by Git.
|
|
- **reports/** is where generated CSV output is stored.
|
|
|
|
## Setup Instructions
|
|
1. Create a virtual environment:
|
|
```bash
|
|
python3 -m venv venv
|
|
source venv/bin/activate
|