Metadata-Version: 2.5
Name: jupyterlab_pyflyby
Version: 5.3.0
Dynamic: Author
Dynamic: Author-email
Dynamic: Keywords
Summary: A labextension to integrate pyflyby with notebooks
Project-URL: Homepage, https://github.com/deshaw/jupyterlab-pyflyby
Project-URL: Bug Tracker, https://github.com/deshaw/jupyterlab-pyflyby/issues
Project-URL: Repository, https://github.com/deshaw/jupyterlab-pyflyby.git
License-Expression: BSD-3-Clause
License-File: LICENSE.txt
Classifier: Framework :: Jupyter
Classifier: Framework :: Jupyter :: JupyterLab
Classifier: Framework :: Jupyter :: JupyterLab :: 4
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.10
Requires-Dist: jupyter-server<3,>=2.13.0
Requires-Dist: pyflyby
Provides-Extra: dev
Requires-Dist: jupyter-builder<2,>=1.2.0; extra == 'dev'
Requires-Dist: jupyterlab<5,>=4.0.0; extra == 'dev'
Provides-Extra: test
Requires-Dist: ipython; extra == 'test'
Description-Content-Type: text/markdown

# @deshaw/jupyterlab_pyflyby

[![PyPI version][pypi-image]][pypi-url] [![PyPI DM][pypi-dm-image]][pypi-url]
[![Github Actions Status][github-status-image]][github-status-url]

A labextension to integrate pyflyby with notebooks

[Pyflyby](https://github.com/deshaw/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)`

![Screenshot](https://github.com/deshaw/jupyterlab-pyflyby/blob/main/docs/pyflyby.gif 'PyFlyBy')

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

## Requirements

- JupyterLab >= 4.0

## Install

```bash
pip install jupyterlab_pyflyby
```

## Contributing

### Development install

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

The `jlpm` command is the pinned version of [yarn](https://yarnpkg.com/) that is
installed with [`jupyter-builder`](https://github.com/jupyterlab/jupyter-builder).
You may use `yarn` or `npm` in lieu of `jlpm` below.

```bash
# Clone the repo to your local environment
# Change directory to the jupyterlab_pyflyby directory
# Install package in development mode, along with the development dependencies
pip install -e ".[dev]"
# Link your development version of the extension with JupyterLab
jupyter-builder 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.

```bash
# 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:

```bash
jupyter lab build --minimize=False
```

#### Endpoint authentication

Every verb method of every handler in `jupyterlab_pyflyby/handlers.py` must carry a
`@tornado.web.authenticated` decorator, or, if an endpoint is deliberately public, an
explicit `@allow_unauthenticated`/`@ws_authenticated` decorator from
`jupyter_server.auth.decorator`. The `build` workflow enforces this by running:

```bash
python .github/scripts/check_auth.py
```

#### Publishing

0. Install dependencies: `pip install twine hatch`
1. Update the version in `package.json` and update the release date in `CHANGELOG.md`
2. Commit the change in step 1
3. For test release, manually trigger the [`Build and publish to PyPI` workflow](https://github.com/deshaw/jupyterlab-pyflyby/actions/workflows/build.yml) - you need to check the `Test release` checkbox
4. Draft a new [GitHub release](https://github.com/deshaw/jupyterlab-pyflyby/releases/new), creating an approriate version tag
5. Publish the draft and verify that the `publish` job in the build workflow passed.

### Uninstall

```bash
pip uninstall jupyterlab_pyflyby
```

## History

This plugin was contributed back to the community by the [D. E. Shaw group](https://www.deshaw.com/).

<p align="center">
    <a href="https://www.deshaw.com">
       <img src="https://www.deshaw.com/assets/logos/blue_logo_417x125.png" alt="D. E. Shaw Logo" height="75" >
    </a>
</p>

## License

This project is released under a [BSD-3-Clause license](https://github.com/deshaw/jupyterlab-pyflyby/blob/master/LICENSE.txt).

We love contributions! Before you can contribute, please sign and submit this [Contributor License Agreement (CLA)](https://www.deshaw.com/oss/cla).
This CLA is in place to protect all users of this project.

"Jupyter" is a trademark of the LF Charities, of which Project Jupyter is a part.

[pypi-url]: https://pypi.org/project/jupyterlab-pyflyby
[pypi-image]: https://img.shields.io/pypi/v/jupyterlab-pyflyby
[pypi-dm-image]: https://img.shields.io/pypi/dm/jupyterlab-pyflyby
[github-status-image]: https://github.com/deshaw/jupyterlab-pyflyby/workflows/Build/badge.svg
[github-status-url]: https://github.com/deshaw/jupyterlab-pyflyby/actions?query=workflow%3ABuild
