Metadata-Version: 2.4
Name: jupyter_package_manager
Version: 1.3.1
Summary: A JupyterLab extension to list, remove and install python packages from pip.
Project-URL: Homepage, https://github.com/mljar/package-manager
Project-URL: Bug Tracker, https://github.com/mljar/package-manager/issues
Project-URL: Repository, https://github.com/mljar/package-manager.git
Author-email: "MLJAR Sp z o.o." <contact@mljar.com>
License-Expression: AGPL-3.0-or-later
License-File: LICENSE
Keywords: jupyter,jupyterlab,jupyterlab-extension
Classifier: Framework :: Jupyter
Classifier: Framework :: Jupyter :: JupyterLab
Classifier: Framework :: Jupyter :: JupyterLab :: 4
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.8
Description-Content-Type: text/markdown


<p align="center">
  <img src="https://github.com/mljar/package-manager/blob/main/media/jupyter-package-manager.jpg?raw=true" alt="Jupyter Package Manager banner"/>
</p>

# Jupyter Package Manager

Package Manager is a JupyterLab extension that simplifies managing Python packages directly within your notebooks. With this extension, you can list, filter, install, and remove packages from pip - all without leaving your JupyterLab environment.

## Features

### List packages 

List all packages installed for the currently open notebook.

<img width="100%" alt="image" src="https://github.com/user-attachments/assets/283adf4b-d56b-4c48-805d-22bf2b22e442" alt="Jupyter Package Manager list packages"/>

### Filtering packages by name 

Quickly search and filter through packages by name.

<img width="100%" src="https://github.com/user-attachments/assets/8936ec19-aeee-4995-9329-edec22a38ada" alt="Jupyter Package Manager filter packages"/>

### Install a new package

Install any new package you need **directly from the notebook interface**.

During installation, you have **access to logs**, including output and error messages, which helps with debugging and troubleshooting.

<img width="100%" src="https://github.com/user-attachments/assets/14cb8f44-fe50-42b1-9208-87d93462c685" alt="Jupyter Package Manager install new package"/>

### Remove package

Easily remove packages that are no longer needed in your current environment, with an additional confirmation step to prevent accidental removal of required packages.

<img width="100%" src="https://github.com/user-attachments/assets/aa1d65f8-6a94-4a50-ba71-cee11161a641" alt="Jupyter Package Manager remove package"/>

### Change PyPI Server

You can easily switch the **PyPI server** to your own **private repository**.

This helps with **secure package management** and better control over installed packages.

<img width="100%" src="https://github.com/user-attachments/assets/69de2ad3-68d6-48fb-a361-051e11fb7076" alt="Jupyter Package Manager change PyPI Server"/>

You can also quickly switch back to the official PyPI server at any time — it only takes a moment.

<img width="100%" src="https://github.com/user-attachments/assets/248676f3-1a93-4c5e-a7ac-db029ebef865" alt="Jupyter Package Manager restore default PyPI Server"/>

### Dark theme

Enjoy a dark mode experience for more comfortable viewing in low-light environments.

<img width="100%" src="https://github.com/user-attachments/assets/ad2f0843-fab4-4a2b-8400-e2b6b7b9419f" alt="Jupyter Package Manager dark theme"/>


## Install extension

It can also be installed in JupyterLab > 4. To install the extension, execute:

```bash
pip install jupyter_package_manager
```

The extenstion is by default available in [MLJAR Studio](https://mljar.com) - a desktop app for creating Python notebooks. 

## Uninstall extension

To remove the extension, execute:

```bash
pip uninstall jupyter_package_manager
```

## Contributing

### Development install

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

The `jlpm` command is JupyterLab's pinned version of
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
`yarn` or `npm` in lieu of `jlpm` below.

```bash
# Clone the repo to your local environment
# Change directory to the package_manager 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 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 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 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
```

### Development uninstall

```bash
pip uninstall jupyter_package_manager
```

In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
folder is located. Then you can remove the symlink named `jupyter-package-manager` within that folder.
