async-kernel


Nameasync-kernel JSON
Version 0.6.3 PyPI version JSON
download
home_pageNone
SummaryA concurrent python kernel for Jupyter supporting AnyIO, AsyncIO and Trio.
upload_time2025-11-04 06:36:28
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

[![pypi](https://img.shields.io/pypi/pyversions/async-kernel.svg)](https://pypi.python.org/pypi/async-kernel)
[![downloads](https://img.shields.io/pypi/dm/async-kernel?logo=pypi&color=3775A9)](https://pypistats.org/packages/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](https://fleming79.github.io/async-kernel/latest/notebooks/concurrency/)
- [Debugger client](https://jupyterlab.readthedocs.io/en/latest/user/debugger.html#debugger)
- [Configurable backend](https://fleming79.github.io/async-kernel/latest/commands/#add-a-kernel-spec)
    - Asyncio (default)
        - [uvloop](https://pypi.org/project/uvloop/) enabled by default[^uv-loop]
    - [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

```bash
pip install async-kernel
```

### Trio

To add a kernel spec for `trio`.

```bash
pip install trio
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.

[^uv-loop]: Uvloop is not a dependency of async-kernel but will be used if it has been installed.

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/0c/88/3856b6a1870f49d02234fac36d3638b6071c81cba38ae12df5470e563bae/async_kernel-0.6.3.tar.gz",
    "platform": null,
    "description": "# Async kernel\n\n[![pypi](https://img.shields.io/pypi/pyversions/async-kernel.svg)](https://pypi.python.org/pypi/async-kernel)\n[![downloads](https://img.shields.io/pypi/dm/async-kernel?logo=pypi&color=3775A9)](https://pypistats.org/packages/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](https://fleming79.github.io/async-kernel/latest/notebooks/concurrency/)\n- [Debugger client](https://jupyterlab.readthedocs.io/en/latest/user/debugger.html#debugger)\n- [Configurable backend](https://fleming79.github.io/async-kernel/latest/commands/#add-a-kernel-spec)\n    - Asyncio (default)\n        - [uvloop](https://pypi.org/project/uvloop/) enabled by default[^uv-loop]\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```bash\npip install async-kernel\n```\n\n### Trio\n\nTo add a kernel spec for `trio`.\n\n```bash\npip install trio\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\n[^uv-loop]: Uvloop is not a dependency of async-kernel but will be used if it has been installed.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A concurrent python kernel for Jupyter supporting AnyIO, AsyncIO and Trio.",
    "version": "0.6.3",
    "project_urls": {
        "Changelog": "https://fleming79.github.io/async-kernel/latest/about/changelog/",
        "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": "cdf88b3710d6135c7cecac406f29cb04a296b4faa1ecc0401770cb00954a0b48",
                "md5": "4414e364931ff2d03d1f359aaf572e6d",
                "sha256": "3fa72ac738f14d4436e17760bb90322774d0bde4fd0997d5473c83e3b1b81540"
            },
            "downloads": -1,
            "filename": "async_kernel-0.6.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4414e364931ff2d03d1f359aaf572e6d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 66225,
            "upload_time": "2025-11-04T06:36:26",
            "upload_time_iso_8601": "2025-11-04T06:36:26.805396Z",
            "url": "https://files.pythonhosted.org/packages/cd/f8/8b3710d6135c7cecac406f29cb04a296b4faa1ecc0401770cb00954a0b48/async_kernel-0.6.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "0c883856b6a1870f49d02234fac36d3638b6071c81cba38ae12df5470e563bae",
                "md5": "fb127d129804df39d1482c31d5420c16",
                "sha256": "17acb6fe0136c7932c3530f2c97fd8f63798cee2cd97406cac94cdd97a08e678"
            },
            "downloads": -1,
            "filename": "async_kernel-0.6.3.tar.gz",
            "has_sig": false,
            "md5_digest": "fb127d129804df39d1482c31d5420c16",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 260161,
            "upload_time": "2025-11-04T06:36:28",
            "upload_time_iso_8601": "2025-11-04T06:36:28.273513Z",
            "url": "https://files.pythonhosted.org/packages/0c/88/3856b6a1870f49d02234fac36d3638b6071c81cba38ae12df5470e563bae/async_kernel-0.6.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-11-04 06:36:28",
    "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: 4.47508s