Added legal disclaimers

Added legal disclaimers to the README file to make sure people are aware that this library is not affiliated, endorsed, or vetted by Yahoo, Inc

CHANGELOG.rst

@@ -1,6 +1,10 @@
 Change Log
 ===========
 
+0.1.67
+------
+- Added legal disclaimers to make sure people are aware that this library is not affiliated, endorsed, or vetted by Yahoo, Inc.
+
 0.1.66
 ------
 - Merged PR to allow yfinance to be pickled

README.md

@@ -5,7 +5,7 @@
 #### \*\*\* IMPORTANT LEGAL DISCLAIMER \*\*\*
 
 ---
-    
+
 **Yahoo!, Y!Finance, and Yahoo! finance are registered trademarks of
 Yahoo, Inc.**
 
@@ -17,7 +17,7 @@ intended for research and educational purposes.
 ([here](https://policies.yahoo.com/us/en/yahoo/terms/product-atos/apiforydn/index.htm),
 [here](https://legal.yahoo.com/us/en/yahoo/terms/otos/index.html), and
 [here](https://policies.yahoo.com/us/en/yahoo/terms/index.htm)) **for
-detailes on your rights to use the actual data downloaded. Remember - the
+details on your rights to use the actual data downloaded. Remember - the
 Yahoo! finance API is intended for personal use only.**
 
 </td></tr></table>

setup.py

@@ -1,15 +1,15 @@
 #!/usr/bin/env python
 # -*- coding: UTF-8 -*-
 #
-# Yahoo! Finance market data downloader (+fix for Pandas Datareader)
+# yfinance - market data downloader
 # https://github.com/ranaroussi/yfinance
 
-"""Yahoo! Finance market data downloader (+fix for Pandas Datareader)"""
+"""yfinance - market data downloader"""
 
 from setuptools import setup, find_packages
 # from codecs import open
-import io
-from os import path
+# import io
+# from os import path
 
 # --- get version ---
 version = "unknown"
@@ -19,17 +19,36 @@
 # --- /get version ---
 
 
-here = path.abspath(path.dirname(__file__))
+# here = path.abspath(path.dirname(__file__))
 
-# Get the long description from the README file
-with io.open(path.join(here, 'README.rst'), encoding='utf-8') as f:
-    long_description = f.read()
+# # Get the long description from the README file
+# with io.open(path.join(here, 'README.rst'), encoding='utf-8') as f:
+#     long_description = f.read()
 
 setup(
     name='yfinance',
     version=version,
-    description='Yahoo! Finance market data downloader',
-    long_description=long_description,
+    description='Download market data from Yahoo! Finance API',
+    long_description="""
+Download market data from Yahoo! Finance's API
+==============================================
+
+** 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 <https://policies.yahoo.com/us/en/yahoo/terms/product-atos/apiforydn/index.htm>`_, `here <https://legal.yahoo.com/us/en/yahoo/terms/otos/index.html>`_, and `here <https://policies.yahoo.com/us/en/yahoo/terms/index.htm>`_) **for detailes on your rights to use the actual data downloaded. Remember: the Yahoo! finance API is intended for personal use only.**
+
+-----
+
+For the latest docs, visit `https://github.com/ranaroussi/yfinance <https://github.com/ranaroussi/yfinance>`_.
+
+Thanks,
+- Ran
+    """,
     url='https://github.com/ranaroussi/yfinance',
     author='Ran Aroussi',
     author_email='[email protected]',
@@ -69,3 +88,9 @@
         ],
     },
 )
+
+print("""
+NOTE: yfinance is not affiliated, endorsed, or vetted by Yahoo, Inc.
+
+You should refer to Yahoo!'s terms of use for details on your rights
+to use the actual data downloaded.""")

test_yfinance.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: UTF-8 -*-
 #
-# Yahoo! Finance market data downloader (+fix for Pandas Datareader)
+# yfinance - market data downloader
 # https://github.com/ranaroussi/yfinance
 
 """

yfinance/__init__.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 #
-# Yahoo! Finance market data downloader (+fix for Pandas Datareader)
+# yfinance - market data downloader
 # https://github.com/ranaroussi/yfinance
 #
 # Copyright 2017-2019 Ran Aroussi

yfinance/base.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 #
-# Yahoo! Finance market data downloader (+fix for Pandas Datareader)
+# yfinance - market data downloader
 # https://github.com/ranaroussi/yfinance
 #
 # Copyright 2017-2019 Ran Aroussi

yfinance/multi.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 #
-# Yahoo! Finance market data downloader (+fix for Pandas Datareader)
+# yfinance - market data downloader
 # https://github.com/ranaroussi/yfinance
 #
 # Copyright 2017-2019 Ran Aroussi

yfinance/shared.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 #
-# Yahoo! Finance market data downloader (+fix for Pandas Datareader)
+# yfinance - market data downloader
 # https://github.com/ranaroussi/yfinance
 #
 # Copyright 2017-2019 Ran Aroussi

yfinance/ticker.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 #
-# Yahoo! Finance market data downloader (+fix for Pandas Datareader)
+# yfinance - market data downloader
 # https://github.com/ranaroussi/yfinance
 #
 # Copyright 2017-2019 Ran Aroussi

yfinance/tickers.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 #
-# Yahoo! Finance market data downloader (+fix for Pandas Datareader)
+# yfinance - market data downloader
 # https://github.com/ranaroussi/yfinance
 #
 # Copyright 2017-2019 Ran Aroussi

yfinance/utils.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 #
-# Yahoo! Finance market data downloader (+fix for Pandas Datareader)
+# yfinance - market data downloader
 # https://github.com/ranaroussi/yfinance
 #
 # Copyright 2017-2019 Ran Aroussi

yfinance/version.py

@@ -1 +1 @@
-version = "0.1.66"
+version = "0.1.67"