Skip to content

Latest commit

 

History

History
114 lines (81 loc) · 5.66 KB

README.md

File metadata and controls

114 lines (81 loc) · 5.66 KB
Raw

Jupyterlab Autosave on Focus Change

PyPi Version Supported Python Versions Github Actions Status Binder Docs

All Contributors

A Jupyterlab extension to autosave files on focus change.


Who doesn't know this scenario, you changed some code or input file and the changes don't apply because (again!) you forgot to save the file.

This is where editor settings to save files when the tab (or the whole editor) loose focus come in super handy.

This extension aims to do the same for jupyterlab as the following setting in VS-Code.

  "files.autoSave": "onFocusChange",

Features

  • Autosave on focus change
  • De-/Activation via Settings Menu
  • File exclusion with glob patterns

Requirements

  • JupyterLab >= 4.0

Install

pip install jupyterlab-autosave-on-focus-change

Contributing

Development install

Note: You will need NodeJS to build the extension package.

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the jupyterlab_autosave_on_focus_change directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm run build

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, the jlpm run build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

jupyter lab build --minimize=False

Uninstall

pip uninstall jupyterlab-autosave-on-focus-change

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Sebastian Weigand
Sebastian Weigand
💻 🤔 🚧 📆 🚇 ⚠️ 📖		 mengyanw
mengyanw
💻 🚧		 Jakub Klinkovský
Jakub Klinkovský
🐛

This project follows the all-contributors specification. Contributions of any kind welcome!