BlueFox/SimpleStockData
1
1
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

Added Installation section with legal disclaimer in README.md

Browse Source
This commit is contained in:
BlueFox 2023-11-24 23:06:41 +01:00
parent a70b1c2466
commit c5003b9665
1 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -5,6 +5,26 @@ You just have to specify a start and an end date, or a specific period, and - if
needed - a currency to convert all stock prices to. needed - a currency to convert all stock prices to.
## Installation
To get started using the library, the pip packages `numpy`, `pandas` and `yfinance`
have to be installed. To do this, type in the following:
```commandline
pip3 install numpy pandas yfinance
```
### Legal Disclaimer
*** IMPORTANT LEGAL DISCLAIMER ***
Yahoo!, Y!Finance, and Yahoo! finance are registered trademarks of Yahoo, Inc.
yfinance is not affiliated, endorsed, or vetted by Yahoo, Inc. It's an open-source tool that uses Yahoo's publicly available APIs, and is intended for research and educational purposes.
You should refer to Yahoo!'s terms of use (here, here, and here) for details on your rights to use the actual data downloaded. Remember - the Yahoo! finance API is intended for personal use only.
[[see also]](https://pypi.org/project/yfinance/)
## Usage ## Usage
### If used as a CLI: ### If used as a CLI:
@ -26,7 +46,7 @@ precise calculations
## License (Unlicense) ## License (Unlicense)
``` ``
This is free and unencumbered software released into the public domain. This is free and unencumbered software released into the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means. Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.