# Google Stock Index Lookup

## Description
This Python library provides command line tools to lookup the current value of
a stock index via a Google search and output the information as a single line.
It leverages the Playwright library to scrape data from Google search results
and parse the relevant information.

## Prerequisites
- Python 3
- Playwright Python package

## Installation
1. Clone this repository to your local machine.

```shell
git clone https://git.4angle.com/edward/google-stocks.git
cd google-stocks
```

2. Install the required Python packages:

```shell
pip install playwright
```

## Usage

### Lookup a Stock Index
To lookup the current value of a stock index and display it as a single line,
you can use the provided scripts.

#### FTSE All Share Example

```shell
ftse_all_share
```

Sample Output:
```
FTSE All-Share Index: 4153.35 (0.85%)
```

#### S&P Total Market Example

```shell
s_and_p_total_market
```

Sample Output:
```
S&P Total Market Index (TMI): 4329.32 (0.64%)
```

## Customization
You can customize the tool by modifying the scripts in the repository. Each
script corresponds to a specific stock index lookup.

## Contributing
Feel free to contribute to this project by opening issues or submitting pull
requests.

## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
for details.

## Author
Edward Betts (edward@4angle.com)

## Acknowledgments
- Playwright: [https://playwright.dev/](https://playwright.dev/)