tiingo-python icon indicating copy to clipboard operation
tiingo-python copied to clipboard

[Enhancement] Add Executable Jupyter Notebook Showing Basic Library Usage

Open hydrosquall opened this issue 7 years ago • 4 comments

Motivation

As a new developer approach approaching this library, I would like to be able to try things out right away without having to install anything. To enable this, we can let people try out online jupyter notebooks using the mybinder.org service (see here). Using the code examples from the README.md would be sufficient as a first pass.

We would want to provide a field that lets the user supply their own API key, since there isn't a public shared account.

Here are 2 projects which use mybinder to provide this capability, with a link to the PR where that capacity was enabled.

  • https://github.com/CartoDB/cartoframes/pull/302
  • https://github.com/jvns/pandas-cookbook/pull/62

If you are interested in picking this up and would like further guidance/mentorship on how to proceed, please let me know.

This is a practical subset of what I'd eventually like to expand into #1.

hydrosquall avatar Dec 15 '18 22:12 hydrosquall

I've added a basic version of this feature for now, but am leaving the issue open since we're still interested in seeing more notebooks with peoples' usage of Tiingo.

hydrosquall avatar Jan 31 '19 03:01 hydrosquall

Here is what I was able to accomplish using API. Hope this helps!

Tiingo Peer Compare.ipynb.zip

i3creations avatar Feb 28 '19 01:02 i3creations

Hello @i3creations! Thank you for taking the time to submit this example - apologies, I'm not sure how I missed the notification when it first came in. I'll open a pull request to add your code to the project's "examples" folder! How would you like to be credited for authorship / would you be interested in adding a brief paragraph describing the motivation for putting together this notebook? Doing a "peer analysis" is something that other people are likely interested in too!

hydrosquall avatar Apr 30 '19 03:04 hydrosquall

No worries!

I’ll draft a paragraph for you in the next few days.

Best Regards,

Michael J. Crandall i3 Creations LLC - Innovation, Integration, Implementation [email protected] https://www.linkedin.com/in/techleaderinnovator/

720.308.2936

On Apr 29, 2019, at 9:27 PM, Cameron Yick [email protected] wrote:

Hello @i3creations! Thank you for taking the time to submit this example - apologies, I'm not sure how I missed the notification when it first came in. I'll open a pull request to add your code to the project's "examples" folder! How would you like to be credited for authorship / would you be interested in adding a brief paragraph describing the motivation for putting together this notebook? Doing a "peer analysis" is something that other people are likely interested in too!

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

i3creations avatar May 02 '19 14:05 i3creations