Skip to main content

A labextension to integrate pyflyby with notebooks

Project description


PyPI version PyPI DM Github Actions Status

A labextension to integrate pyflyby with notebooks

Pyflyby helps you get rid of the tedious task of recalling and adding import statements. This labextension takes it further by adding the import statements automatically in your notebook. For eg. executing np.arange(10)


You can decide cell where imports should be added by adding 'pyflyby-cell' cell tag to it.


  • JupyterLab >= 4.0


pip install jupyterlab_pyflyby


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_pyflyby 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

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


Before starting, you'll need to have run: pip install twine jupyter_packaging

  1. Update the version in package.json and update the release date in
  2. Commit the change in step 1, tag it, then push it
git commit -am <msg>
git tag vX.Z.Y
git push && git push --tags
  1. Create the artifacts
rm -rf dist tsconfig.tsbuildinfo lib jupyterlab_pyflyby/labextension jupyterlab_pyflyby-*.tar.gz jupyterlab_pyflyby-*.whl
hatch build .
  1. Test this against the test pypi. You can then install from here to test as well:
twine upload --repository-url jupyterlab_pyflyby-*.tar.gz jupyterlab_pyflyby-*.whl# In a new venv
pip install --index-url jupyterlab_pyflyby
  1. Upload this to pypi:
twine upload jupyterlab_pyflyby-*.tar.gz jupyterlab_pyflyby-*.whl


pip uninstall jupyterlab_pyflyby


This plugin was contributed back to the community by the D. E. Shaw group.

D. E. Shaw Logo


This project is released under a BSD-3-Clause license.

We love contributions! Before you can contribute, please sign and submit this Contributor License Agreement (CLA). This CLA is in place to protect all users of this project.

"Jupyter" is a trademark of the NumFOCUS foundation, of which Project Jupyter is a part.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyterlab_pyflyby-5.1.0.tar.gz (124.2 kB view hashes)

Uploaded source

Built Distribution

jupyterlab_pyflyby-5.1.0-py3-none-any.whl (28.3 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page