LICENSE.md | ||
README.md |
SimpleStockData
SimpleStockData is a simple library providing an API to access basic stock prices. 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.
1. Installation
1.1 Requirements
Python >= 2.7, 3.4+
Pandas >= 1.3.0
Numpy >= 1.16.5
requests >= 2.31
lxml >= 4.9.1
appdirs >= 1.4.4
pytz >=2022.5
frozendict >= 2.3.4
beautifulsoup4 >= 4.11.1
html5lib >= 1.1
peewee >= 3.16.2
Requirements from yfinance [see also]
1.2 Installing these
To get started using the library, the pip packages named in 1.1 have to be installed. To do this, type in the following:
pip3 install numpy pandas yfinance requests lxml
1.3 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.
2. Usage
2.1 If used as a CLI:
TODO;
2.2 If used as a Module in Python (via import
):
TODO;
3. Thanks to
-
yfinance - the library used in the background to get stock prices and exchange rates from Yahoo Finance.
-
Pandas - the powerful Python data analysis toolkit
-
Numpy - used in combination with pandas for precise calculations
4. License (Unlicense)
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.
In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
For more information, please refer to <http://unlicense.org/>