Metadata-Version: 2.4
Name: jupy-notebook
Version: 0.1.1
Summary: Jupy: a lightweight, brutalist, local Python notebook server with terminal, environments, pip manager, widgets, debugger, and exports.
Author-email: Hariom Lohar <hariomlohar.new@gmail.com>
Maintainer-email: Hariom Lohar <hariomlohar.new@gmail.com>
License: 
        MIT License
        
        Copyright (c) 2026 Hariom lohar
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: Homepage, https://github.com/hariomlohardev/pkg_jupy
Project-URL: Repository, https://github.com/hariomlohardev/pkg_jupy
Project-URL: Issues, https://github.com/hariomlohardev/pkg_jupy/issues
Keywords: notebook,jupyter,ipython,data-science,terminal,local-notebook,python-notebook
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Jupyter
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
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
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: User Interfaces
Classifier: Topic :: System :: Shells
Classifier: Topic :: Utilities
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: psutil>=5.9
Provides-Extra: terminal
Requires-Dist: pywinpty>=2.0; sys_platform == "win32" and extra == "terminal"
Provides-Extra: watch
Requires-Dist: watchdog>=3.0; extra == "watch"
Provides-Extra: nb
Requires-Dist: nbformat>=5.9; extra == "nb"
Provides-Extra: all
Requires-Dist: pywinpty>=2.0; sys_platform == "win32" and extra == "all"
Requires-Dist: watchdog>=3.0; extra == "all"
Requires-Dist: nbformat>=5.9; extra == "all"
Dynamic: license-file

# 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

<p align="center">
  <a href="https://pypi.org/project/jupy-notebook/">
    <img src="https://img.shields.io/pypi/v/jupy-notebook.svg?label=PyPI" alt="PyPI version" />
  </a>
  <a href="https://pypi.org/project/jupy-notebook/">
    <img src="https://img.shields.io/pypi/pyversions/jupy-notebook.svg" alt="Python versions" />
  </a>
  <a href="https://github.com/hariomlohardev/pkg_jupy/LICENSE">
    <img src="https://img.shields.io/github/license/hariomlohardev/pkg_jupy.svg" alt="License" />
  </a>
  <a href="https://github.com/hariomlohardev/pkg_jupy/issues">
    <img src="https://img.shields.io/github/issues/hariomlohardev/pkg_jupy.svg" alt="Issues" />
  </a>
  <a href="https://github.com/hariomlohardev/pkg_jupy">
    <img src="https://img.shields.io/github/stars/hariomlohardev/pkg_jupy.svg?style=social" alt="GitHub stars" />
  </a>
</p>

---

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

```bash
python -m pip install jupy-notebook
```

For full terminal support on Windows, install:

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

For all optional features:

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

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

---

## Install from source

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

Then run:

```bash
jupy --help
```

---

## Quickstart

Start the notebook server:

```bash
jupy
```

Or explicitly:

```bash
jupy serve
```

Then open your browser at:

```text
http://localhost:8000
```

You can also run:

```bash
python -m jupy
```

---

## CLI Commands

### Server

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

### Doctor / Health Check

```bash
jupy doctor
jupy doctor --full
```

### Status

```bash
jupy status
```

### Environments

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

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

### Notebooks

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

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

```bash
python -m pip install pywinpty
```

Or install Jupy with terminal support:

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

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

---

## Project Structure

```text
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:

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

Create a virtual environment:

```bash
python -m venv .venv
```

Activate it:

### Windows

```bash
.venv\Scripts\activate
```

### macOS / Linux

```bash
source .venv/bin/activate
```

Install in editable mode:

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

Run:

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