{"id":15014474,"url":"https://github.com/ipython-contrib/ipython-markdown-inspector","last_synced_at":"2025-04-09T19:23:17.579Z","repository":{"id":223354840,"uuid":"758529647","full_name":"ipython-contrib/ipython-markdown-inspector","owner":"ipython-contrib","description":null,"archived":false,"fork":false,"pushed_at":"2024-02-27T10:31:48.000Z","size":102,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-20T11:21:17.218Z","etag":null,"topics":["ipython","ipython-extension","jupyterlab","jupyterlab-extension","notebook"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ipython-contrib.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-02-16T14:18:19.000Z","updated_at":"2024-08-31T21:42:50.000Z","dependencies_parsed_at":"2024-02-22T15:26:55.280Z","dependency_job_id":"bf28ba8a-ee28-4a7a-a191-16b5efffd018","html_url":"https://github.com/ipython-contrib/ipython-markdown-inspector","commit_stats":null,"previous_names":["krassowski/ipython-markdown-inspector","ipython-contrib/ipython-markdown-inspector"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipython-contrib%2Fipython-markdown-inspector","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipython-contrib%2Fipython-markdown-inspector/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipython-contrib%2Fipython-markdown-inspector/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipython-contrib%2Fipython-markdown-inspector/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ipython-contrib","download_url":"https://codeload.github.com/ipython-contrib/ipython-markdown-inspector/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248095891,"owners_count":21046936,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ipython","ipython-extension","jupyterlab","jupyterlab-extension","notebook"],"created_at":"2024-09-24T19:45:40.645Z","updated_at":"2025-04-09T19:23:17.545Z","avatar_url":"https://github.com/ipython-contrib.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ipython-markdown-inspector\n\n[![tests](https://github.com/ipython-contrib/ipython-markdown-inspector/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/ipython-contrib/ipython-markdown-inspector/actions/workflows/tests.yml)\n![CodeQL](https://github.com/ipython-contrib/ipython-markdown-inspector/workflows/CodeQL/badge.svg)\n[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/ipython-contrib/ipython-markdown-inspector/main?urlpath=lab)\n[![pypi-version](https://img.shields.io/pypi/v/ipython-markdown-inspector.svg)](https://python.org/pypi/ipython-markdown-inspector)\n\nIPython extension providing inspection results as Markdown, enabling better integration with Jupyter Notebook and JupyterLab.\nDepends on [`docstring-to-markdown`](https://github.com/python-lsp/docstring-to-markdown).\n\n![](https://raw.githubusercontent.com/ipython-contrib/ipython-markdown-inspector/main/docs/demo.png)\n\n## Installation\n\nRequires `IPython` 8.22 or newer (which requires Python 3.10 or newer).\n\n```bash\npip install ipython-markdown-inspector\n```\n\n## Usage\n\nTo load an extension while IPython is running, use the `%load_ext` magic:\n\n```ipython\n%load_ext ipython_markdown_inspector\n```\n\nTo load it each time IPython starts, list it in your [configuration file](https://ipython.readthedocs.io/en/stable/config/intro.html):\n\n```python\nc.InteractiveShellApp.extensions = [\n    'ipython_markdown_inspector'\n]\n```\n\nAfter enabling the extension, both the contents of \"Contextual Help\" panel,\nand results of info requests such as `%run?` or `df?` will provide the output in Markdown format.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fipython-contrib%2Fipython-markdown-inspector","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fipython-contrib%2Fipython-markdown-inspector","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fipython-contrib%2Fipython-markdown-inspector/lists"}