async-kernel


Nameasync-kernel JSON
Version 0.1.1 PyPI version JSON
download
home_pageNone
SummaryA concurrent python kernel for Jupyter supporting AnyIO, AsyncIO and Trio.
upload_time2025-08-28 21:43:58
maintainerNone
docs_urlNone
authorNone
requires_python>=3.11
licenseNone
keywords interactive interpreter jupyter shell web
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # Async kernel

[![image](https://img.shields.io/pypi/pyversions/async-kernel.svg)](https://pypi.python.org/pypi/async-kernel)
[![CI](https://github.com/fleming79/async-kernel/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/fleming79/async-kernel/actions/workflows/ci.yml)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
[![basedpyright - checked](https://img.shields.io/badge/basedpyright-checked-42b983)](https://docs.basedpyright.com)
[![Built with Material for MkDocs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=plastic&logo=MaterialForMkDocs&logoColor=white)](https://squidfunk.github.io/mkdocs-material/)
[![codecov](https://codecov.io/github/fleming79/async-kernel/graph/badge.svg?token=PX0RWNKT85)](https://codecov.io/github/fleming79/async-kernel)

Async kernel is a Python [Jupyter kernel](https://docs.jupyter.org/en/latest/projects/kernels.html#kernels-programming-languages) that runs in an [anyio](https://pypi.org/project/anyio/) event loop.

**[Documentation](https://fleming79.github.io/async-kernel/)**

## Highlights

- Concurrent message handling
- [Debugger client](https://jupyterlab.readthedocs.io/en/latest/user/debugger.html#debugger)
- Configurable backend
    - Asyncio (default)
        - [uvloop](https://pypi.org/project/uvloop/) enabled by default
    - [trio](https://pypi.org/project/trio/) backend
- [IPython shell](https://ipython.readthedocs.io/en/stable/overview.html#enhanced-interactive-python-shell) provides:
    - code execution
    - magic
    - code completions
    - history

[![Link to demo](https://github.com/user-attachments/assets/9a4935ba-6af8-4c9f-bc67-b256be368811)](https://fleming79.github.io/async-kernel/simple_example/ "Show demo notebook.")

## Installation

```shell
pip install async-kernel
```

### Trio

To add a kernel spec for `trio`.

```shell
pip install trio
```

```shell
async-kernel -a async-trio
```

## Origin

Async kernel started as a [fork](https://github.com/ipython/ipykernel/commit/8322a7684b004ee95f07b2f86f61e28146a5996d)
of [IPyKernel](https://github.com/ipython/ipykernel). Thank you to the original contributors of IPyKernel that made Async kernel possible.

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "async-kernel",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": "Interactive, Interpreter, Jupyter, Shell, Web",
    "author": null,
    "author_email": "Alan Fleming <async-python@proton.me>",
    "download_url": "https://files.pythonhosted.org/packages/11/a2/63b5cf0e050b3387085658c0444401aae42821001d1dda9fe40ea203566e/async_kernel-0.1.1.tar.gz",
    "platform": null,
    "description": "# Async kernel\n\n[![image](https://img.shields.io/pypi/pyversions/async-kernel.svg)](https://pypi.python.org/pypi/async-kernel)\n[![CI](https://github.com/fleming79/async-kernel/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/fleming79/async-kernel/actions/workflows/ci.yml)\n[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)\n[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)\n[![basedpyright - checked](https://img.shields.io/badge/basedpyright-checked-42b983)](https://docs.basedpyright.com)\n[![Built with Material for MkDocs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=plastic&logo=MaterialForMkDocs&logoColor=white)](https://squidfunk.github.io/mkdocs-material/)\n[![codecov](https://codecov.io/github/fleming79/async-kernel/graph/badge.svg?token=PX0RWNKT85)](https://codecov.io/github/fleming79/async-kernel)\n\nAsync kernel is a Python [Jupyter kernel](https://docs.jupyter.org/en/latest/projects/kernels.html#kernels-programming-languages) that runs in an [anyio](https://pypi.org/project/anyio/) event loop.\n\n**[Documentation](https://fleming79.github.io/async-kernel/)**\n\n## Highlights\n\n- Concurrent message handling\n- [Debugger client](https://jupyterlab.readthedocs.io/en/latest/user/debugger.html#debugger)\n- Configurable backend\n    - Asyncio (default)\n        - [uvloop](https://pypi.org/project/uvloop/) enabled by default\n    - [trio](https://pypi.org/project/trio/) backend\n- [IPython shell](https://ipython.readthedocs.io/en/stable/overview.html#enhanced-interactive-python-shell) provides:\n    - code execution\n    - magic\n    - code completions\n    - history\n\n[![Link to demo](https://github.com/user-attachments/assets/9a4935ba-6af8-4c9f-bc67-b256be368811)](https://fleming79.github.io/async-kernel/simple_example/ \"Show demo notebook.\")\n\n## Installation\n\n```shell\npip install async-kernel\n```\n\n### Trio\n\nTo add a kernel spec for `trio`.\n\n```shell\npip install trio\n```\n\n```shell\nasync-kernel -a async-trio\n```\n\n## Origin\n\nAsync kernel started as a [fork](https://github.com/ipython/ipykernel/commit/8322a7684b004ee95f07b2f86f61e28146a5996d)\nof [IPyKernel](https://github.com/ipython/ipykernel). Thank you to the original contributors of IPyKernel that made Async kernel possible.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A concurrent python kernel for Jupyter supporting AnyIO, AsyncIO and Trio.",
    "version": "0.1.1",
    "project_urls": {
        "Documentation": "https://fleming79.github.io/async-kernel",
        "Homepage": "https://fleming79.github.io/async-kernel",
        "Source": "https://github.com/fleming79/async-kernel",
        "Tracker": "https://github.com/fleming79/async-kernel/issues"
    },
    "split_keywords": [
        "interactive",
        " interpreter",
        " jupyter",
        " shell",
        " web"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ded003cbf9da6a5580ba9ecbf6418e672a3abaf13843e05272b34f79b9c43691",
                "md5": "f0af81c80a4e4617b379cb5238e8e93c",
                "sha256": "496f19432e96a2c2bd5058fa6c448bc877b8cac3c486fe1b5c991a0474935e3e"
            },
            "downloads": -1,
            "filename": "async_kernel-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f0af81c80a4e4617b379cb5238e8e93c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 58415,
            "upload_time": "2025-08-28T21:43:56",
            "upload_time_iso_8601": "2025-08-28T21:43:56.686005Z",
            "url": "https://files.pythonhosted.org/packages/de/d0/03cbf9da6a5580ba9ecbf6418e672a3abaf13843e05272b34f79b9c43691/async_kernel-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "11a263b5cf0e050b3387085658c0444401aae42821001d1dda9fe40ea203566e",
                "md5": "d91f2532555ff41d27bb888a05a38c86",
                "sha256": "84ea280dd2617cbfc6740989e02a22ec8eeeeedc190cdb8c004ede65c5fb675f"
            },
            "downloads": -1,
            "filename": "async_kernel-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "d91f2532555ff41d27bb888a05a38c86",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 233517,
            "upload_time": "2025-08-28T21:43:58",
            "upload_time_iso_8601": "2025-08-28T21:43:58.336430Z",
            "url": "https://files.pythonhosted.org/packages/11/a2/63b5cf0e050b3387085658c0444401aae42821001d1dda9fe40ea203566e/async_kernel-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-28 21:43:58",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "fleming79",
    "github_project": "async-kernel",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "async-kernel"
}
None
Elapsed time: 1.38006s