-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update and rename README.txt to README.md
- Loading branch information
1 parent
0cd7a80
commit efa4a4d
Showing
1 changed file
with
6 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,10 @@ | ||
yfinanceapi (Equity and currency information API) | ||
# yfinanceapi (Equity and currency information API) | ||
|
||
Description | ||
----------- | ||
## Description | ||
|
||
The yfinanceapi is an API for Python that builds on top of the Yahoo! finance JSON API to provide equity and currency information, such as price, volume, last trade time etc. | ||
|
||
Installation | ||
------------ | ||
## Installation | ||
|
||
The API can be installed from PyPi using the following command: | ||
pip install yfinanceapi | ||
|
@@ -17,8 +15,7 @@ pip install git+https://github.com/Karthik005/yfinanceapi#egg=yfinanceapi | |
|
||
The installation may require root permissions. | ||
|
||
Usage | ||
----- | ||
## Usage | ||
|
||
The API can be imported in the following manner: | ||
|
||
|
@@ -41,20 +38,12 @@ Currency values are measured with respect to USD. | |
Additional functions, information on usage and allowed symbol values can be found in the docstrings of the api.py file. | ||
|
||
|
||
Copyright | ||
--------- | ||
## Copyright | ||
|
||
Copyright 2015, Karthik.S | ||
|
||
|
||
License | ||
------- | ||
## License | ||
|
||
This project is licensed under GNU v2.0. For more information read the LICENSE.txt file. | ||
|
||
|
||
Bugs and requests | ||
---------------- | ||
|
||
Bugs and feature requests can be reported at [email protected] | ||
|