Skip to main content

Jupy: a lightweight, brutalist, local Python notebook server with terminal, environments, pip manager, widgets, debugger, and exports.

Project description

Jupy

Jupy is a lightweight, local-first, brutalist Python notebook server.

It gives you a fast local notebook environment with code cells, markdown cells, rich output, plots, widgets, debugger, variable explorer, file browser, environment manager, pip manager, terminal, checkpoints, exports, and CLI tools.

Everything runs locally on your machine.


Badges

PyPI version Python versions License Issues GitHub stars


Features

  • Local Python notebook server
  • Code cells with Python execution
  • Markdown cells with live preview
  • Rich output rendering
  • Matplotlib plot support
  • Interactive widgets
  • Variable explorer
  • Debugger panel
  • File browser
  • Session notes
  • Checkpoints
  • Environment manager
  • Pip package manager
  • Real terminal
  • Export notebook to HTML, Python, Markdown, and print-ready PDF
  • Headless notebook execution
  • Command-line interface
  • Theme engine
  • Brutalist UI design

Installation

Install from PyPI:

python -m pip install jupy-notebook

For full terminal support on Windows, install:

python -m pip install "jupy-notebook[terminal]"

For all optional features:

python -m pip install "jupy-notebook[all]"

Optional extras

Extra Purpose
terminal Full Windows terminal support using pywinpty
watch File watching support using watchdog
nb Headless notebook execution using nbformat
all All optional dependencies

Example:

python -m pip install "jupy-notebook[terminal]"

Install from source

git clone https://github.com/hariomlohardev/pkg_jupy.git
cd pkg_jupy
python -m pip install -e ".[all]"

Then run:

jupy --help

Quickstart

Start the notebook server:

jupy

Or explicitly:

jupy serve

Then open your browser at:

http://localhost:8000

You can also run:

python -m jupy

CLI Commands

Server

jupy
jupy serve
jupy serve --port 9000
jupy serve --no-browser
jupy serve --dir ./my_project

Doctor / Health Check

jupy doctor
jupy doctor --full

Status

jupy status

Environments

jupy env list
jupy env create datasci
jupy env use named datasci
jupy env use global
jupy env use project
jupy env info
jupy env path
jupy env delete datasci

Pip

jupy pip list
jupy pip install numpy
jupy pip install "requests==2.32.0"
jupy pip uninstall numpy

Notebooks

jupy new analysis
jupy run analysis.ipynb --output executed.ipynb
jupy export analysis.ipynb --format html
jupy export analysis.ipynb --format py
jupy export analysis.ipynb --format md
jupy export analysis.ipynb --format pdf

Project Utilities

jupy init
jupy init --sample
jupy combine --output files.md
jupy config show
jupy config set env_mode named
jupy config set env_name datasci

Windows Terminal

On Windows, the real terminal requires pywinpty.

Install it with:

python -m pip install pywinpty

Or install Jupy with terminal support:

python -m pip install "jupy-notebook[terminal]"

Without pywinpty, Windows falls back to a limited pipe-based terminal.


Project Structure

pkg_jupy/
  pyproject.toml
  README.md
  LICENSE
  MANIFEST.in
  create_readme.py
  jupy/
    __init__.py
    __main__.py
    cli.py
    combine.py
    run_notebook.py
    core/
      __init__.py
      autocomplete.py
      envmanager.py
      metrics.py
      terminal.py
      venv.py
      kernel/
        __init__.py
        manager.py
        worker_script.py
    server/
      __init__.py
      handlers.py
      protocol.py
    static/
      index.html
      css/
      js/

Development

Clone the repository:

git clone https://github.com/hariomlohardev/pkg_jupy.git
cd pkg_jupy

Create a virtual environment:

python -m venv .venv

Activate it:

Windows

.venv\Scripts\activate

macOS / Linux

source .venv/bin/activate

Install in editable mode:

python -m pip install -e ".[all]"

Run:

jupy --help
jupy doctor --full
jupy serve --no-browser

Version

Current version: 0.1.0


Repository

GitHub: https://github.com/hariomlohardev/pkg_jupy

Issues: https://github.com/hariomlohardev/pkg_jupy/issues

PyPI: https://pypi.org/project/jupy-notebook/


License

MIT License

Copyright (c) 2026 hariomlohardev

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

jupy_notebook-0.1.1.tar.gz (124.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jupy_notebook-0.1.1-py3-none-any.whl (163.2 kB view details)

Uploaded Python 3

File details

Details for the file jupy_notebook-0.1.1.tar.gz.

File metadata

  • Download URL: jupy_notebook-0.1.1.tar.gz
  • Upload date:
  • Size: 124.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.14

File hashes

Hashes for jupy_notebook-0.1.1.tar.gz
Algorithm Hash digest
SHA256 5f1194af9960fe9d4f306b5377c105d6574644d23178f29c4abefbdac1884886
MD5 8d6a05caef8084899785728956b87b3b
BLAKE2b-256 8aa2a9ea60bd0a3ead2fb7ce7a67e104f23090d48ce2f3dc520ac556397db145

See more details on using hashes here.

File details

Details for the file jupy_notebook-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: jupy_notebook-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 163.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.14

File hashes

Hashes for jupy_notebook-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c99195f56ffbe45d4af6046f6ead7101b9e9ffea8794f15e82053eadf0ddd1d1
MD5 241414011b51e7948083d21167178b03
BLAKE2b-256 32037300cb2e94822f2d4d3e9674cbe60f853e5d51e61b1a78bcffbd97304523

See more details on using hashes here.

Supported by

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