Skip to main content

A JupyterLab extension to convert plaintext files to jupyter notebooks

Project description

jupyter-plainb

Github Actions Status

A JupyterLab extension to convert plaintext files to Jupyter notebooks

Installation

pip install jupyter-plainb

Requirements

  • JupyterLab >= 4.0.0

Usage

Right-click menu

Select a .py or .md file in the file browser → right-click → Convert to Notebook submenu → pick a parser.

If a .ipynb with the same base name already exists, a confirmation dialog asks before overwriting.

Auto-convert on startup

Add plainTextNotebookConfig to jupyter_config.json (or JupyterLite's jupyter-lite.json):

{
  "jupyter-config-data": {
    "plainTextNotebookConfig": {
      "rules": [
        { "dir": "percent", "parser": "parsePy" },
        { "dir": "sphinx_gallery", "parser": "parseSphinxGallery" },
        { "dir": "markdown", "parser": "parseClassicMd" },
        { "dir": "myst", "parser": "parseMystMd" }
      ]
    }
  }
}

Each rule watches a directory and converts matching files on JupyterLab startup (skips files that already have a .ipynb sibling).

Supported formats

Parser Menu label File type Format
parsePy Percent format (.py) .py Jupytext percent
parseSphinxGallery Sphinx Gallery (.py) .py Sphinx-Gallery
parseClassicMd Classic Markdown (.md) .md Standard markdown — fenced code blocks become code cells
parseMystMd MyST Notebook (.md) .md MyST-NB {code-cell} directives

Uninstall

pip uninstall jupyter-plainb

Contributing

See CONTRIBUTING.md

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

jupyter_plainb-0.2.0.tar.gz (396.6 kB view details)

Uploaded Source

Built Distribution

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

jupyter_plainb-0.2.0-py3-none-any.whl (24.4 kB view details)

Uploaded Python 3

File details

Details for the file jupyter_plainb-0.2.0.tar.gz.

File metadata

  • Download URL: jupyter_plainb-0.2.0.tar.gz
  • Upload date:
  • Size: 396.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for jupyter_plainb-0.2.0.tar.gz
Algorithm Hash digest
SHA256 9701d2c9d6579160e861d0121e0ece0b6c929d0e1f1ed920258ff44d6848ac53
MD5 a3e892c7faa0d2d5c9d02e4ccb22d667
BLAKE2b-256 b4b67f8fe5da19c915999ac268beb3503b61c99f0a23dba182b89de1685dc47d

See more details on using hashes here.

File details

Details for the file jupyter_plainb-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: jupyter_plainb-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 24.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for jupyter_plainb-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7a469a7e815792834cf32b3753718431066de30b78e04db860abfd7b42bea446
MD5 62543101a8fcc739acd901c42d8657e8
BLAKE2b-256 208e91fadd27a1611eefaa4032474aefb07f7863b01b35d63befc92109e0ef50

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