runcell docs

runcell.dev

runcell is a powerful Python package and JupyterLab extension designed to enhance your Jupyter notebook experience. It provides advanced cell execution capabilities and integrates seamlessly with JupyterLab 4.0+.

Features

• Lightning Fast: Optimized performance with native compilation for each platform
• Secure & Private: Your data stays local with enterprise-grade security
• Resource Efficient: Minimal system requirements with maximum capability
• JupyterLab Integration: Seamless integration with JupyterLab's modern interface
• Python 3.10+ Support: Built for modern Python environments

Quick Installation

The fastest way to get started with runcell is through pip:

pip install runcell

Requirements

Before installing runcell, ensure you have:

• Python 3.10 or higher
• JupyterLab 4.0 or higher (Jupyter Notebook is not supported)
• pip package manager
• Internet connection for installation

Checking Your Environment

Verify your Python version:

python --version

Check your JupyterLab version:

jupyter lab --version

If you need to upgrade JupyterLab:

pip install --upgrade jupyterlab

Installation Methods

Method 1: Install from PyPI (Recommended)

pip install runcell

This is the recommended method as it automatically handles dependencies and installs the latest version.

Method 2: Using conda

If you're using conda environments:

1. Activate your conda environment:

conda activate your-environment-name

2. Install runcell using pip (recommended within conda):

pip install runcell

Method 3: Using uv (Ultra-fast)

If you have uv installed:

uv pip install runcell

To install uv if you don't have it:

pip install uv

Method 4: Manual Installation from Wheel

1. Download the wheel file from the releases
2. Install using pip:

pip install runcell-0.1.0-py3-none-any.whl

Getting Started

Step 1: Install runcell

Choose one of the installation methods above.

Step 2: Start JupyterLab

jupyter lab

Step 3: Find the Extension

After JupyterLab starts:

1. Look for the runcell extension in the right sidebar
2. Click on the runcell icon to activate the extension
3. Follow the login/setup process if prompted

Troubleshooting

Extension Not Appearing

If you don't see the runcell extension in JupyterLab:

1. Restart JupyterLab completely after installation
2. Clear your browser cache and refresh the page
3. Verify JupyterLab version - ensure you're using JupyterLab 4.0+ (not Jupyter Notebook)
4. Check the right sidebar specifically for the extension

JupyterLab Version Issues

runcell requires JupyterLab 4.0 or higher. If you're using an older version:

pip install --upgrade jupyterlab

For conda users:

conda install -c conda-forge jupyterlab

Python Version Issues

runcell requires Python 3.10 or higher. To check your version:

python --version

To upgrade Python:

• Using pyenv (recommended): pyenv install 3.11 && pyenv global 3.11
• Using conda: conda install python=3.11
• Direct download: Visit python.org

Permission Errors

If you encounter permission errors during installation:

pip install --user runcell

Conda Environment Issues

For conda users experiencing issues:

1. Create a new environment with the correct Python version:

conda create -n runcell-env python=3.11 jupyterlab

2. Activate the environment:

conda activate runcell-env

3. Install runcell with pip:

pip install runcell

Frequently Asked Questions

Can I use runcell with Jupyter Notebook?

No, runcell currently only supports JupyterLab 4.0+. The classic Jupyter Notebook interface is not supported.

To switch from Jupyter Notebook to JupyterLab:

pip install jupyterlab
jupyter lab  # instead of jupyter notebook

What's the difference between the installation methods?

• pip from PyPI (recommended): Automatic dependency management, always latest version
• conda + pip: Best for conda users, maintains environment isolation
• uv: Fastest installation, good for CI/CD environments
• Manual wheel: For offline installations or specific version requirements

Why use pip within conda environments?

While conda is excellent for environment management, pip provides better compatibility for Python wheel files and ensures proper installation of JupyterLab extensions.

How do I verify the installation worked?

1. Start JupyterLab: jupyter lab
2. Check the right sidebar for the runcell extension
3. The extension should appear as an icon in the sidebar
4. Click on it to access runcell functionality

Support

If you're still experiencing issues after following this guide:

1. Verify all requirements are met:

python --version && jupyter lab --version

This should show Python 3.10+ and JupyterLab 4.0+

2. Try a clean installation in a new environment
3. Check the JupyterLab logs for any error messages

Version Information

• Current Version: 0.1.0
• Python Support: 3.10+
• JupyterLab Support: 4.0+
• License: Free to start

Ready to enhance your Jupyter notebook experience? Install runcell today and discover the power of advanced cell execution capabilities!