How to Upload Github File to Jupyter Without Signing in

This article is a Git 101 for Jupyter users. Advanced Git users might want to check out integration workflow, existent world examples and FAQs for making notebooks play nicely with GitHub.

This is a hands on tutorial for beginners & is meant to be comprehensive. Feel free to skip a section if you're already familar with information technology. At the end you lot'll be able to,

• Push your notebooks to a GitHub repository in cloud
• Get-go versioning your notebooks
• Learn how to revert to a specific notebook version
• Review Jupyter notebook pull requests on GitHub
• Go feedback & discuss notebook changes with your peers
• Hands share your notebooks for others to view

Create GitHub Account

If you don't have a GitHub business relationship delight create one here.

Setup Git

• Download and install the latest version of Git.

• Setup your name & email in git past running post-obit commands on concluding

                                    >> git config --global user.proper name "Mona Lisa"   >> git config --global user.electronic mail "email@instance.com"                              

• Connect your local git client with GitHub by caching your password.

Create New Repository

A GitHub repository is like your supercharged binder in the cloud. You can store files (notebooks, data, source lawmaking), look at historical changes to these files, open issues, hash out changes and much more. People typically create one repository per project.

Allow's get ahead & create a repository on GitHub. Once created, y'all'll see a folio like below, copy the highlighted repository URL.

Clone Repository

Let'south clone the GitHub repository on our motorcar by running post-obit on the terminal. It will create projectA directory on our auto which is linked to amit1rrr/projectA repository on GitHub.

                          >> git clone https://github.com/amit1rrr/projectA.git     Cloning into 'projectA'...     alarm: You appear to have cloned an empty repository.                      

Push Notebooks to GitHub

Our repository is empty right now, let'due south push button some notebooks to information technology. We copy two notebooks to the directory where nosotros cloned projectA repository,

                          >> cp /some/path/analysis1.ipynb /path/of/projectA/     >> cp /some/path/scratch.ipynb /path/of/projectA/                      

Let'south say we want to push analysis1.ipynb to GitHub. Nosotros commencement need to tell local git client to start tracking the file.

                          >> git add together analysis1.ipynb                      

You tin check which files are being tracked with git status,

You lot can encounter that analysis1.ipynb is under "Changes to be committed:" so it's being tracked by our local git client. Now let's commit the changes,

                          # -thousand flag is used to provide a human friendly bulletin describing the modify     >> git commit -thou "Adds customer information analysis notebook"                      

Commit simply creates a checkpoint that you can revert to at whatsoever time. Allow's push this commit to GitHub.

Now you can visit the repository page on GitHub to see your commits.

Develop in a Branch

Say you are working on a large project spanning multiple days, but you lot need to periodically push button piece of work in progress commits. The way to do that is by creating a feature branch.

Each repository has a default branch (typically master or main) that stores well-nigh upwardly-to-appointment versions of completed work. Each member of your squad can create their ain characteristic branches to store their WIP commits. When their work in a feature branch is ready to exist shared they tin can create a pull request for peer review & subsequently merge the feature branch into master. Let's unpack that with physical steps.

Say I'm about to beginning working on a new projection to analyse client data. Kickoff, I volition create a new branch,

                          >> git checkout -b customer_data_insights                      

And then I'll create/edit some notebooks & other files to practise the actual analysis. When I'grand ready to commit my WIP, I'll practise the usual git add, git commit, git push button. At git push you will see post-obit fault since the co-operative does not be on GitHub yet.

Simply push the branch start by copying the command shown in mistake,

                          >> git push --set-upstream origin customer_data_insights                      

So practise git push to push your commits to this newly created branch.

Create Pull Request

Let's say yous've been working on feature branch for a while, and it's ready for prime fourth dimension. Most likely, you'd desire to first share it with your peers, get their feedback earlier merging it into chief branch. That's what pull requests are for.

You tin can create pull requests from GitHub UI. Become to your Projection folio -> Pull requests tab -> click "New pull asking".

Cull which branch y'all'd like to merge into primary. Verify commits & listing of files changed. Click "Create pull request".

On the next folio provide title & depict your changes in cursory, striking "Create pull request" once more.

Review Notebook Pull Request

GitHub pull request are fantastic for peer review as they allow y'all encounter changes side-by-side & annotate on them. Merely in case of Jupyter, GitHub shows JSON diffs which are really hard to read (see beneath).

You can use ReviewNB to solve the notebook diff'ing problem. Information technology shows y'all rich diffs & lets y'all comment on any notebook cell to discuss changes with your squad.

Once your changes are approved you can merge them from GitHub UI.

Or run git merge + git push from control line,

Revert to a specific notebook version

If you desire to temporarily go back to a commit, checkout the files, and come back to where y'all are then you tin can merely checkout the desired commit. At the terminate run "git checkout master" to become back to the electric current country.

If yous desire to actually revert to an sometime state and brand some changes at that place, you lot can start a new branch from that commit.

                          >> git checkout -b old-state f33939cd63004e3e67b111f7bcb350ffd2b0608a                      

You can also browse old commits on GitHub past going to Your project page -> Commits. Open the desired commit and click "View File" to come across the notebook condition at that commit.

When you scan notebooks in your repository on GitHub information technology renders them as HTML. So information technology'due south very convenient to share read-simply links to the notebook like this 1. If it'due south a individual repository, the person you are sharing the link with needs to have a GitHub account and accept permission to access your repository.

For security reasons, GitHub does not run any Javascript in the notebook. You lot can apply nbviewer or ReviewNB if your notebook contains interactive widgets and such.

Conclusion

If you are new to Git, it can take some time to get used to all the commands. Only it'due south a proven way of collaborating on software projects & is widely used in data science work as well. Y'all can combine information technology with ReviewNB to remove some of the kinks in the workflow.

Happy Hacking!

woodspreve1951.blogspot.com

Source: https://blog.reviewnb.com/github-jupyter-notebook/

Share this post