| Name | ipython-markdown-inspector JSON |
| Version |
0.0.0
JSON |
| download |
| home_page | |
| Summary | |
| upload_time | 2024-02-19 20:20:08 |
| maintainer | |
| docs_url | None |
| author | Michał Krassowski |
| requires_python | >=3.10 |
| license | BSD 3-Clause License Copyright (c) 2024, Michał Krassowski Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
ipython
docstring
inpsector
markdown
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ipython-markdown-inspector
[](https://github.com/krassowski/ipython-markdown-inspector/actions?query=workflow%3A%22tests%22)
[](https://python.org/pypi/ipython-markdown-inspector)
IPython extension providing Inspection outputs as Markdown, enabling better integration with Jupyter Notebook and JupyterLab.
Depends on [`docstring-to-markdown`](https://github.com/python-lsp/docstring-to-markdown).
## Installation
Requires `IPython` 8.21 or newer (which requires Python 3.10 or newer).
```bash
pip install ipython-markdown-inspector
```
## Usage
To load an extension while IPython is running, use the `%load_ext` magic:
```ipython
%load_ext ipython_markdown_inspector
```
To load it each time IPython starts, list it in your [configuration file](https://ipython.readthedocs.io/en/stable/config/intro.html):
```python
c.InteractiveShellApp.extensions = [
'ipython_markdown_inspector'
]
```
After enabling the extension, both the contents of "Contextual Help" panel,
and results of info requests such as `%run?` or `df?` will provide the output in Markdown format.
Raw data
{
"_id": null,
"home_page": "",
"name": "ipython-markdown-inspector",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "IPython,docstring,inpsector,markdown",
"author": "Micha\u0142 Krassowski",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/63/eb/c0e6153124ab91695223fd1c5d3250cee6f4278362ad3df8b92d84a0f150/ipython_markdown_inspector-0.0.0.tar.gz",
"platform": null,
"description": "# ipython-markdown-inspector\n\n[](https://github.com/krassowski/ipython-markdown-inspector/actions?query=workflow%3A%22tests%22)\n\n[](https://python.org/pypi/ipython-markdown-inspector)\n\nIPython extension providing Inspection outputs 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\n\n## Installation\n\nRequires `IPython` 8.21 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",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2024, Micha\u0142 Krassowski Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "",
"version": "0.0.0",
"project_urls": {
"Bug Tracker": "https://github.com/krassowski/ipython-markdown-inspector/issues",
"Repository": "https://github.com/krassowski/ipython-markdown-inspector.git"
},
"split_keywords": [
"ipython",
"docstring",
"inpsector",
"markdown"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "92c390d79b78544644db245ea8b4ca978da208d5b0fcc01ef1a79625d338268b",
"md5": "d4fb47ba0675fe375d46defb3c90cffa",
"sha256": "fd860a9cbddfb97d2c5a5e63fa22529809b2a4e598167c720b11b21f0a844ac2"
},
"downloads": -1,
"filename": "ipython_markdown_inspector-0.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d4fb47ba0675fe375d46defb3c90cffa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 7751,
"upload_time": "2024-02-19T20:20:04",
"upload_time_iso_8601": "2024-02-19T20:20:04.607343Z",
"url": "https://files.pythonhosted.org/packages/92/c3/90d79b78544644db245ea8b4ca978da208d5b0fcc01ef1a79625d338268b/ipython_markdown_inspector-0.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "63ebc0e6153124ab91695223fd1c5d3250cee6f4278362ad3df8b92d84a0f150",
"md5": "352a8659157bce322c7c2cd3b2d7e013",
"sha256": "11c7835d60439309ad72757e6609776ca8974fb665fa43572fd5ad921566fe65"
},
"downloads": -1,
"filename": "ipython_markdown_inspector-0.0.0.tar.gz",
"has_sig": false,
"md5_digest": "352a8659157bce322c7c2cd3b2d7e013",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 93575,
"upload_time": "2024-02-19T20:20:08",
"upload_time_iso_8601": "2024-02-19T20:20:08.163043Z",
"url": "https://files.pythonhosted.org/packages/63/eb/c0e6153124ab91695223fd1c5d3250cee6f4278362ad3df8b92d84a0f150/ipython_markdown_inspector-0.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-19 20:20:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "krassowski",
"github_project": "ipython-markdown-inspector",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ipython-markdown-inspector"
}
