Update README

Fix installation instructions, and miscellaneous cleanup
This commit is contained in:
Samuel Sloniker 2021-12-04 18:50:15 -08:00
parent 1bd1ced732
commit 14be2b99c5

View File

@ -1,6 +1,5 @@
`stockquotes` is a simple Python module for collecting stock/ETF and mutual fund quotes and `stockquotes` is a Python module for collecting stock, ETF, and mutual fund
historical data from Yahoo! Finance. It's perfect for developers who can't quotes and historical data from Yahoo! Finance.
afford the (often high) prices charged by many stock data APIs.
# Requirements # Requirements
* Python 3.6+ * Python 3.6+
@ -8,7 +7,9 @@ afford the (often high) prices charged by many stock data APIs.
# Installation # Installation
pip3 install stockquotes pip3 install git+https://github.com/kj7rrv/stockquotes
Do not install from PyPI; the PyPI package is no longer updated.
# Usage # Usage
First, import the `stockquotes` module. First, import the `stockquotes` module.
@ -48,7 +49,8 @@ for recent IPOs. Also, a known but unexplained bug causes it to only give two
days of data for some stocks. days of data for some stocks.
# Exceptions # Exceptions
`stockquotes.StockDoesNotExistError` is raised when the stock does not exist. `stockquotes.StockDoesNotExistError` is raised when the stock does not (appear
to) exist.
`stockquotes.NetworkError` is raised when a connection to Yahoo! Finance `stockquotes.NetworkError` is raised when a connection to Yahoo! Finance
cannot be established. cannot be established.