{"action":"created","issue":{"url":"https://api.github.com/repos/ellisonbg/altair/issues/154","repository_url":"https://api.github.com/repos/ellisonbg/altair","labels_url":"https://api.github.com/repos/ellisonbg/altair/issues/154/labels{/name}","comments_url":"https://api.github.com/repos/ellisonbg/altair/issues/154/comments","events_url":"https://api.github.com/repos/ellisonbg/altair/issues/154/events","html_url":"https://github.com/ellisonbg/altair/issues/154","id":164695461,"number":154,"title":"Move notebooks into Python package?","user":{"login":"ellisonbg","id":27600,"avatar_url":"https://avatars.githubusercontent.com/u/27600?v=3","gravatar_id":"","url":"https://api.github.com/users/ellisonbg","html_url":"https://github.com/ellisonbg","followers_url":"https://api.github.com/users/ellisonbg/followers","following_url":"https://api.github.com/users/ellisonbg/following{/other_user}","gists_url":"https://api.github.com/users/ellisonbg/gists{/gist_id}","starred_url":"https://api.github.com/users/ellisonbg/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ellisonbg/subscriptions","organizations_url":"https://api.github.com/users/ellisonbg/orgs","repos_url":"https://api.github.com/users/ellisonbg/repos","events_url":"https://api.github.com/users/ellisonbg/events{/privacy}","received_events_url":"https://api.github.com/users/ellisonbg/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":3,"created_at":"2016-07-10T02:19:08Z","updated_at":"2016-07-10T22:29:48Z","closed_at":null,"body":"I have created a `tutorial` function that downloads the documentation notebooks from github and puts them into the users cwd. This makes it really easy for a user to grab the notebooks and play with Altair using:\r\n\r\n```python\r\nfrom altair import tutorial\r\ntutorial()\r\n```\r\n\r\nHowever, right now I am downloading the notebooks from github. If we moved the notebooks into the Python package, it solves a couple of problems:\r\n\r\n* We can always know that the right version of the notebooks will be used by the user and don't have to keep updating the github URL to track the right commit/tag for the release.\r\n* No internet required for a user to grab the example notebooks.\r\n* Eventually, ipython/jupyter will likely have the ability to allow users to see/explore notebook based documentation. The mostly likely discovery mechanism will be entry points. Moving notebooks inside the package makes this an easy transition.\r\n\r\nEventually, imagine a magic that works like this:\r\n\r\n```python\r\n%nbdoc altair\r\n```\r\n\r\nOr \r\n\r\n```python\r\n%nbdoc sklearn\r\n```\r\n\r\nThe only downside is that a user won't see a top level notebooks directory. But we could keep it and put a README that points the user to the notebooks inside the package.\r\n\r\n@fperez @jakevdp @willingc @Carreau"},"comment":{"url":"https://api.github.com/repos/ellisonbg/altair/issues/comments/231614786","html_url":"https://github.com/ellisonbg/altair/issues/154#issuecomment-231614786","issue_url":"https://api.github.com/repos/ellisonbg/altair/issues/154","id":231614786,"user":{"login":"jakevdp","id":781659,"avatar_url":"https://avatars.githubusercontent.com/u/781659?v=3","gravatar_id":"","url":"https://api.github.com/users/jakevdp","html_url":"https://github.com/jakevdp","followers_url":"https://api.github.com/users/jakevdp/followers","following_url":"https://api.github.com/users/jakevdp/following{/other_user}","gists_url":"https://api.github.com/users/jakevdp/gists{/gist_id}","starred_url":"https://api.github.com/users/jakevdp/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jakevdp/subscriptions","organizations_url":"https://api.github.com/users/jakevdp/orgs","repos_url":"https://api.github.com/users/jakevdp/repos","events_url":"https://api.github.com/users/jakevdp/events{/privacy}","received_events_url":"https://api.github.com/users/jakevdp/received_events","type":"User","site_admin":false},"created_at":"2016-07-10T22:29:48Z","updated_at":"2016-07-10T22:29:48Z","body":"I'd be fine with wrapping them in, as long as it's clear where to find them from the README & other documentation pages."}}
{"actor":{"display_login":"jakevdp"}}