Metadata-Version: 2.3
Name: yahoo-finance-symbols
Version: 0.1.2
Classifier: Programming Language :: Rust
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Dist: pandas ==2.2.2
Summary: A Library for scraping all Ticker Symbols from Yahoo Finance
License: MIT
Requires-Python: >=3.7
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Source Code, https://github.com/Nnamdi-sys/yahoo-finance-symbols

# YAHOO FINANCE SYMBOLS

This Library helps in scraping 350,000+ symbols from yahoo finance. The symbols are saved in a local sqlite database which can be used directly or accessed with the rust or python library functions.

## Installation

### Python

``` bash
pip install yahoo_finance_symbols
```

### Rust

``` bash
cargo install yahoo_finance_symbols
```


## Examples

### Python

``` python
import yahoo_finance_symbols as ys

# Fetch All Symbols
all_symbols = ys.get_symbols()
print(all_symbols)

# Search for Symbols With a Keyword
symbols = ys.search_symbols("Bitcoin", "ETF")
print(symbols)

# Update the Database
ys.update_database()
```

### Rust

``` rust
use yahoo_finance_symbols::keys::{AssetClass, Category, Exchange};
use yahoo_finance_symbols::{get_symbols, search_symbols, update_database};
use std::error::Error;

#[tokio::main]
async fn main() -> Result<(), Box<dyn Error>> {

    // Fetch All Symbols
    let all_symbols = get_symbols(AssetClass::All, Category::All, Exchange::All).await?;
    println!("{:?}", all_symbols);

    // Search for Symbols with a Keyword
    let symbols = search_symbols("Apple", "Equity").await?;
    println!("{:?}", symbols);

    // Update the Database
    update_database().await()?;
}
```


