Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Enhancement] Add Executable Jupyter Notebook Showing Basic Library Usage #197

Open
hydrosquall opened this issue Dec 15, 2018 · 4 comments

Comments

@hydrosquall
Copy link
Owner

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.

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
Copy link
Owner Author

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.

@i3creations
Copy link

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

Tiingo Peer Compare.ipynb.zip

@hydrosquall
Copy link
Owner Author

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!

@i3creations
Copy link

i3creations commented May 2, 2019 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants