Skip to content

Commit fffe89e

Browse files
authored
README: simplify a little
1 parent a9e70b4 commit fffe89e

File tree

1 file changed

+14
-26
lines changed

1 file changed

+14
-26
lines changed

README.md

Lines changed: 14 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -32,43 +32,31 @@ Yahoo! finance API is intended for personal use only.**
3232
<a target="new" href="https://github.com/ranaroussi/yfinance"><img border=0 src="https://img.shields.io/github/stars/ranaroussi/yfinance.svg?style=social&label=Star&maxAge=60" alt="Star this repo"></a>
3333
<a target="new" href="https://twitter.com/aroussi"><img border=0 src="https://img.shields.io/twitter/follow/aroussi.svg?style=social&label=Follow&maxAge=60" alt="Follow me on twitter"></a>
3434

35+
**yfinance** offers a Pythonic way to fetch financial & market data from [Yahoo!Ⓡ finance](https://finance.yahoo.com).
3536

36-
**yfinance** offers a threaded and Pythonic way to download market data from [Yahoo!Ⓡ finance](https://finance.yahoo.com).
37+
## Main components
3738

38-
## Main Features
39-
- `Ticker` module: Class for accessing single ticker data.
40-
- `Tickers` module: Class for handling multiple tickers.
41-
- `download` Efficiently download market data for multiple tickers.
42-
- `Sector` and `Industry` modules : Classes for accessing sector and industry information.
43-
- Market Screening: `EquityQuery` and `Screener` to build query and screen the market.
44-
- Caching and Smart Scraping
39+
- `Ticker`: single ticker data
40+
- `Tickers`: multiple tickers' data
41+
- `download`: download market data for multiple tickers
42+
- `Sector` and `Industry`: sector and industry information
43+
- `EquityQuery` and `Screener`: build query to screen market
4544

46-
## Documentation
47-
The official documentation is available on [ranaroussi.github.io/yfinance](https://ranaroussi.github.io/yfinance/index.html)
45+
## **NEW DOCUMENTATION WEBSITE**: [ranaroussi.github.io/yfinance](https://ranaroussi.github.io/yfinance/index.html)
4846

4947
## Installation
5048

51-
Install `yfinance` using `pip`:
49+
Install `yfinance` from PYPI using `pip`:
5250

5351
``` {.sourceCode .bash}
54-
$ pip install yfinance --upgrade --no-cache-dir
52+
$ pip install yfinance
5553
```
5654

57-
[With Conda](https://anaconda.org/ranaroussi/yfinance).
58-
59-
To install with optional dependencies, replace `optional` with: `nospam` for [caching-requests](#smarter-scraping), `repair` for [price repair](https://github.com/ranaroussi/yfinance/wiki/Price-repair), or `nospam,repair` for both:
60-
61-
``` {.sourceCode .bash}
62-
$ pip install "yfinance[optional]"
63-
```
64-
65-
[Required dependencies](./requirements.txt) , [all dependencies](./setup.py#L62).
66-
67-
The list of changes can be found in the [changelog](https://github.com/ranaroussi/yfinance/blob/main/CHANGELOG.rst)
68-
55+
The list of changes can be found in the [Changelog](https://github.com/ranaroussi/yfinance/blob/main/CHANGELOG.rst)
6956

7057
## Developers: want to contribute?
71-
`yfinance` relies on community to investigate bugs and contribute code. Developer guide: https://github.com/ranaroussi/yfinance/discussions/1084
58+
59+
`yfinance` relies on community to investigate bugs, review code, and contribute code. Developer guide: https://github.com/ranaroussi/yfinance/discussions/1084
7260

7361
---
7462

@@ -77,7 +65,6 @@ The list of changes can be found in the [changelog](https://github.com/ranarouss
7765
**yfinance** is distributed under the **Apache Software License**. See
7866
the [LICENSE.txt](./LICENSE.txt) file in the release for details.
7967

80-
8168
AGAIN - yfinance is **not** affiliated, endorsed, or vetted by Yahoo, Inc. It's
8269
an open-source tool that uses Yahoo's publicly available APIs, and is
8370
intended for research and educational purposes. You should refer to Yahoo!'s terms of use
@@ -93,3 +80,4 @@ details on your rights to use the actual data downloaded.
9380
Please drop me a note with any feedback you have.
9481

9582
**Ran Aroussi**
83+

0 commit comments

Comments
 (0)