✨ Features

📦 Installation

pip install jupy-notebook

Windows terminal (full ConPTY support):

pip install "jupy-notebook[terminal]"

Everything (terminal + file watching + headless execution):

pip install "jupy-notebook[all]"

Requirements

• Python 3.9+
• No other mandatory dependencies (psutil auto-installs)

🚀 Quickstart

# Start the notebook server (opens browser automatically)
jupy

# Or explicitly
jupy serve --port 8000

# Start without opening a browser
jupy serve --no-browser

# Serve a specific project folder
jupy serve --dir ./my_project

Then open http://localhost:8000 and start coding.

🖥️ CLI Reference

jupy                          Start the notebook server (default)
jupy serve [options]          Start the notebook server
jupy doctor [--full]          Check installation health
jupy status                   Show environment + version info

jupy theme add <name>         Install a theme from the store
jupy theme browse             List all available themes
jupy theme search <query>     Search the theme store
jupy theme list               List installed themes
jupy theme use <name>         Activate a theme
jupy theme remove <name>      Uninstall a theme
jupy theme update [--all]     Update theme(s)
jupy theme import <file>      Install from a local .yml/.json
jupy theme export <name>      Export a theme to a file
jupy theme current            Show the active theme
jupy theme reset              Reset to the Jupy default
jupy theme new <name>         Scaffold a new theme for contributors
jupy theme refresh            Force-refresh the theme store cache

jupy env list                 List environments
jupy env create <name>        Create a global environment
jupy env use <mode> [name]    Set active environment (global/project/named)
jupy env info                 Show active environment details
jupy env path                 Print active environment path
jupy env delete <name>        Delete an environment

jupy pip list                 List installed packages
jupy pip install <spec>       Install a package
jupy pip uninstall <name>     Uninstall a package

jupy run <notebook> [-o out]  Execute a notebook headlessly
jupy export <notebook> --format html|py|md|pdf
jupy new <name>               Create a new notebook
jupy init [--sample]          Initialize a folder for Jupy
jupy combine [-o files.md]    Compile project files into one Markdown
jupy config show|set          Show or set per-folder config

🎨 Theme Store

Jupy connects to the themes_jupy community registry.

From the CLI:

jupy theme browse              # see what's available
jupy theme add nord-frost      # install
jupy theme use nord-frost      # activate

From the browser: click the 🎨 icon on the left activity rail → STORE tab → browse previews → click INSTALL.

Create your own theme:

jupy theme new my-theme        # scaffolds theme.yml + about.json
# edit the files, add a preview.png, then open a PR to themes_jupy

⌨️ Keyboard Shortcuts

Command Mode (press Esc first)

Edit Mode

📁 Project Structure

my_project/
├── .jupy/
│   ├── config.json          # per-folder env config
│   └── checkpoints/         # notebook snapshots
├── my_notebook.ipynb
└── ...

Global data (environments, themes) lives in your OS app-data folder:

🛠️ Development

git clone https://github.com/hariomlohardev/jupy.git
cd jupy
pip install -e ".[all]"
jupy serve

Building & Publishing

pip install build twine
python -m build
twine check dist/*
twine upload dist/*

🤝 Contributing

1. Fork the repo
2. Create a feature branch: git checkout -b feat/my-feature
3. Commit: git commit -m "feat: add my feature"
4. Push: git push origin feat/my-feature
5. Open a Pull Request

Contributing Themes

jupy theme new my-theme
# edit theme.yml + about.json, add preview.png
# open a PR to https://github.com/hariomlohardev/themes_jupy

📄 License

MIT

🙏 Acknowledgments

• Design inspired by Jupyter, Google Colab, and VS Code
• Terminal powered by xterm.js + pywinpty
• Theme store powered by themes_jupy
• Editor powered by CodeMirror 5