Merge pull request #212 from hydrosquall/feature/add-binder-example

[Documentation Feature] Add Runnable Example on Mybinder.org

.gitignore

@@ -70,3 +70,6 @@ travis_pypi_setup.py
 # Mac
 .DS_Store
 
+# Jupyter
+examples/.ipynb_checkpoints
+

.travis.yml

@@ -17,6 +17,7 @@ install:
 
 language: python
 python:
+  - 3.7
   - 3.6
   - 3.5
   - 3.4

HISTORY.rst

@@ -2,11 +2,17 @@
 History
 =======
 
-0.8.x (2018-XX-XX)
+
+0.9.x (2019-XX-XX)
 ------------------
 * New changes go here!
 
 
+0.9.x (2019-01-30)
+------------------
+* Documentation: Added runnable jupyter notebook sample under "/examples"
+* Minor: bumped various library dependencies
+
 0.8.0 (2018-07-06)
 ------------------
 * Major: Add IEX Endpoint to retrieve data with intraday frequencies (@dcwtx #125)

README.rst

@@ -21,6 +21,9 @@ Tiingo Python
      :target: https://pyup.io/repos/github/hydrosquall/tiingo-python/
      :alt: Updates
 
+.. image:: https://mybinder.org/badge_logo.svg :target: https://mybinder.org/v2/gh/hydrosquall/tiingo-python/master?filepath=examples%2Fbasic-usage-with-pandas.ipynb
+
+
 
 Tiingo is a financial data platform that makes high quality financial tools available to all. Tiingo has a REST and Real-Time Data API, which this library helps you to access. Presently, the API includes support for the following endpoints:
 
@@ -31,6 +34,11 @@ Tiingo is a financial data platform that makes high quality financial tools avai
 Usage
 --------
 
+If you'd like to try this library without installing anything, click the button below. Otherwise, continue reading.
+
+.. image:: https://mybinder.org/badge_logo.svg :target: https://mybinder.org/v2/gh/hydrosquall/tiingo-python/master?filepath=examples%2Fbasic-usage-with-pandas.ipynb
+
+
 First, install the library from PyPi:
 
 .. code-block:: shell

binder/requirements.txt

@@ -0,0 +1,6 @@
+# This file is used by mybinder.org to power the runnable examples.
+tiingo
+
+# You technically don't have to use tiingo with pandas, but
+# we included it since most data analysts will have it installed already.
+pandas

docs/index.rst

@@ -19,6 +19,8 @@ Welcome to Tiingo Python's documentation!
     :target: https://codecov.io/gh/hydrosquall/tiingo-python
     :alt: Coverage
 
+.. image:: https://mybinder.org/badge_logo.svg :target: https://mybinder.org/v2/gh/hydrosquall/tiingo-python/
+
 
 Contents:
 
@@ -37,7 +39,12 @@ Contents:
 Tiingo is a financial data platform that makes high quality financial tools available to all. They have a RESTful and Real-Time Data API. Presently, the API includes support for the following endpoints:
 
 * Stock Market Ticker Closing Prices + Metadata. Data includes full distribution details and is validated using a proprietary EOD Price Engine.
-* (Coming Soon): Curated news from top financial news sources + curated blogs. Stories are tagged by Tiingo's algorithms.
+* Curated news from top financial news sources + curated blogs. Stories are tagged by Tiingo's algorithms.
+
+If you'd like to try this library without installing anything, click the button below. Otherwise, continue reading.
+
+.. image:: https://mybinder.org/badge_logo.svg :target: https://mybinder.org/v2/gh/hydrosquall/tiingo-python/master?filepath=examples%2Fbasic-usage-with-pandas.ipynb
+
 
 
 Indices and tables

setup.py

@@ -74,6 +74,7 @@ setup(
         'Programming Language :: Python :: 3.4',
         'Programming Language :: Python :: 3.5',
         'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
     ],
     test_suite='tests',
     tests_require=test_requirements,

tiingo/__version__.py

@@ -1,2 +1,2 @@
 # -*- coding: utf-8 -*-
-__version__ = '0.8.0'
+__version__ = '0.9.0'