myst-nb-json


Namemyst-nb-json JSON
Version 0.1.2 PyPI version JSON
download
home_pageNone
SummaryA MIME-type plugin for rendering JSON output from Jupyter notebooks to HTML
upload_time2024-07-01 11:53:45
maintainerNone
docs_urlNone
authorNone
requires_python==3.9.*
licenseMIT
keywords docutils sphinx json
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # MyST-NB JSON

A MIME-type plugin for rendering JSON output from Jupyter notebooks to HTML

______________________________________________________________________

Outputs from Jupyter notebook code cells usually contain representations in one or multiple MIME
types (image, text…). IPython provides multiple built-in output types, but not all of them
have a representation for HTML, and fall back to a stringified version of the Python object.

This is the case for the `application/json` type:

It is nicely rendered in Jupyter because Jupyter includes a
[JSON renderer](https://github.com/jupyterlab/jupyterlab/tree/7909745d075aceb0cf1099ad53a3174e92b575ae/packages/json-extension),
but [MyST-NB](https://myst-nb.readthedocs.io) can only use IPython's built-ins which display as
`<IPython.core.display.JSON object>`.

## Jupyter Lab

![Screenshot of json_dict in Jupyter](./docs/images/example1-jupyter.png)

## MyST-NB without plugin

![Screenshot of json_dict in HTML by MyST-NB](./docs/images/example1-myst-nb.png)

## MyST-NB with myst-nb-json plugin

![Screenshot of json_dict in HTML with myst-nb-json](./docs/images/example1-myst-nb-json.png)

## Implementation

This package requires (besides MyST-NB) no other dependencies. The front-end code is written in
plain HTML/JavaScript, avoiding heavy dependencies and built steps.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "myst-nb-json",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "==3.9.*",
    "maintainer_email": null,
    "keywords": "docutils, sphinx, json",
    "author": null,
    "author_email": "\"Alexandrov Team, EMBL\" <andreas.eisenbarth@embl.de>, Andreas Eisenbarth <andreas.eisenbarth@embl.de>",
    "download_url": "https://files.pythonhosted.org/packages/c1/c3/18fdb45c218476c751264617c593f83de17ef982a8452c2a1b2e92435d52/myst_nb_json-0.1.2.tar.gz",
    "platform": null,
    "description": "# MyST-NB JSON\n\nA MIME-type plugin for rendering JSON output from Jupyter notebooks to HTML\n\n______________________________________________________________________\n\nOutputs from Jupyter notebook code cells usually contain representations in one or multiple MIME\ntypes (image, text\u2026). IPython provides multiple built-in output types, but not all of them\nhave a representation for HTML, and fall back to a stringified version of the Python object.\n\nThis is the case for the `application/json` type:\n\nIt is nicely rendered in Jupyter because Jupyter includes a\n[JSON renderer](https://github.com/jupyterlab/jupyterlab/tree/7909745d075aceb0cf1099ad53a3174e92b575ae/packages/json-extension),\nbut [MyST-NB](https://myst-nb.readthedocs.io) can only use IPython's built-ins which display as\n`<IPython.core.display.JSON object>`.\n\n## Jupyter Lab\n\n![Screenshot of json_dict in Jupyter](./docs/images/example1-jupyter.png)\n\n## MyST-NB without plugin\n\n![Screenshot of json_dict in HTML by MyST-NB](./docs/images/example1-myst-nb.png)\n\n## MyST-NB with myst-nb-json plugin\n\n![Screenshot of json_dict in HTML with myst-nb-json](./docs/images/example1-myst-nb-json.png)\n\n## Implementation\n\nThis package requires (besides MyST-NB) no other dependencies. The front-end code is written in\nplain HTML/JavaScript, avoiding heavy dependencies and built steps.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A MIME-type plugin for rendering JSON output from Jupyter notebooks to HTML",
    "version": "0.1.2",
    "project_urls": {
        "changelog": "https://github.com/aeisenbarth/myst-nb-json/main/CHANGELOG.md",
        "documentation": "https://aeisenbarth.github.io/myst-nb-json/",
        "homepage": "https://github.com/aeisenbarth/myst-nb-json/",
        "issues": "https://github.com/aeisenbarth/myst-nb-json/issues/",
        "repository": "https://github.com/aeisenbarth/myst-nb-json.git"
    },
    "split_keywords": [
        "docutils",
        " sphinx",
        " json"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1aedd702175411d2085129a4e974a499e1b9d692a5bdb536eb4f469923aad321",
                "md5": "a14442bd00ba271dc4fa70f60e268827",
                "sha256": "509598e4ed98818951aeceee58f3a9597635d9b389a714ebb6bbda6d5f35156c"
            },
            "downloads": -1,
            "filename": "myst_nb_json-0.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a14442bd00ba271dc4fa70f60e268827",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "==3.9.*",
            "size": 7377,
            "upload_time": "2024-07-01T11:53:44",
            "upload_time_iso_8601": "2024-07-01T11:53:44.788535Z",
            "url": "https://files.pythonhosted.org/packages/1a/ed/d702175411d2085129a4e974a499e1b9d692a5bdb536eb4f469923aad321/myst_nb_json-0.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c1c318fdb45c218476c751264617c593f83de17ef982a8452c2a1b2e92435d52",
                "md5": "16f91deb05ca01588912271fa442f888",
                "sha256": "c07fd17368eb70181c3ddab40450c54d86c10b93c2d7c77ee2307d9f2df276f1"
            },
            "downloads": -1,
            "filename": "myst_nb_json-0.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "16f91deb05ca01588912271fa442f888",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "==3.9.*",
            "size": 9436,
            "upload_time": "2024-07-01T11:53:45",
            "upload_time_iso_8601": "2024-07-01T11:53:45.766915Z",
            "url": "https://files.pythonhosted.org/packages/c1/c3/18fdb45c218476c751264617c593f83de17ef982a8452c2a1b2e92435d52/myst_nb_json-0.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-01 11:53:45",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "aeisenbarth",
    "github_project": "myst-nb-json",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "myst-nb-json"
}
        
Elapsed time: 0.29768s