https://github.com/bamresearch/jupyter-integration
Configures Anaconda on Windows and associates double-click on .ipynb files with JupyterLab. To get version controlled Jupyter notebooks, it installs an extension to commit changes directly from JupyterLab, no command-line interaction necessary. |> https://bamresearch.github.io/jupyter-integration |> https://www.youtube.com/channel/UC0Jlyc60Nxc7FF_3Sjq8f6g
https://github.com/bamresearch/jupyter-integration
git ipynb jupyter-notebook jupyterlab reproducibility tortoisegit version-control versioning
Last synced: about 2 months ago
JSON representation
Configures Anaconda on Windows and associates double-click on .ipynb files with JupyterLab. To get version controlled Jupyter notebooks, it installs an extension to commit changes directly from JupyterLab, no command-line interaction necessary. |> https://bamresearch.github.io/jupyter-integration |> https://www.youtube.com/channel/UC0Jlyc60Nxc7FF_3Sjq8f6g
- Host: GitHub
- URL: https://github.com/bamresearch/jupyter-integration
- Owner: BAMresearch
- License: mit
- Created: 2019-04-09T15:15:55.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-05-19T17:22:04.000Z (almost 4 years ago)
- Last Synced: 2025-09-09T13:51:10.094Z (6 months ago)
- Topics: git, ipynb, jupyter-notebook, jupyterlab, reproducibility, tortoisegit, version-control, versioning
- Language: Batchfile
- Homepage:
- Size: 6.28 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Jupyter Git Scripts
A collection of batch scripts helping with version controlled Jupyter
notebooks on Windows and associates double-click on `.ipynb` files with JupyterLab.
Installs an extension for GIT to commit changes on a notebook
directly from JupyterLab, no command-line interaction necessary.
The scripts are intended to be run by restricted users
typically found in corporate computing environments.
## Features
### `Anaconda Update Script.bat`
- Registers the Jupyter notebook file extension `.ipynb` so that a double-click
starts JupyterLab and opens the notebook.
- Installs Jupyter extensions for interactive widgets (ipywidgets) in JupyterLab
and installs nodeJS which is required for that.
- Installs GIT extension `jupyterlab_git` for JupyterLab.
- Adds some TortoiseGit actions to the context menu for easier access (*diff*, *log*, *rename*, *delete*).
- Updates the Anaconda Python distribution
and creates a log file of the process next to the scripts location.
- Does not require admin rights.
(Assumes Anaconda is installed in the users home folder.)
### `New Jupyter Project.bat`
1. Presents a dialog asking the user for an empty project folder,
allows a new folder to be created.
2. Initializes GIT in that project folder, using user name and email provided
by Windows via Active Directory.
3. Sets up GIT with Jupyter notebook filtering (nbstripout) in that folder.
4. Adds a copy of the notebook template *New Project Notebook.ipynb* from *config* folder.
5. Adds configured GIT submodules as well.
- Expects a config file *config\local.conf* relative to the script location
with the following content:
```
NewProjectOrigin=https:///%USERNAME%
NewProjectSubMods=https:////jupyter_analysis_tools.git
```
### `Pull All Projects.bat`
Recursively updates the current GIT repository and all submodules within from
remote (server possibly) and checks out the latest master.
### `Push All Projects.bat`
Recursively sends the recent commits of the current GIT repository and all
submodules within to the remote (server possibly).
## Requirements
- [Git for Windows](https://git-scm.com/download/win)
- **optional**: [TortoiseGit](https://tortoisegit.org/download/)
(requires admin rights during install)
- [Anaconda Python](https://www.anaconda.com/distribution/),
expected in default location for users (`%LOCALAPPDATA%`)
## Terms of use
Please see the included *LICENSE* file.
Use at your own risk!
## Contact
I am very much looking forward to your feedback!
Feel free to use the issue tracker for requests or bug reports.