async-kernel 0.1.0rc0__tar.gz

async_kernel-0.1.0rc0/.github/dependabot.yaml

@@ -0,0 +1,16 @@
+version: 2
+updates:
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    groups:
+      actions:
+        patterns:
+          - "*"
+  # https://docs.astral.sh/uv/guides/integration/dependency-bots/#dependabot
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "weekly"

async_kernel-0.1.0rc0/.github/release.yml

@@ -0,0 +1,27 @@
+changelog:
+  exclude:
+    authors:
+      - dependabot
+      - pre-commit-ci
+  categories:
+    - title: 🏗️ Breaking Changes
+      labels:
+        - Semver-Major
+        - breaking-change
+    - title: 🚀 Features
+      labels:
+        - feature
+        - enhancement
+    - title: 🧪 Dependencies
+      labels:
+        - update
+    - title: 🐛 Fixes
+      labels:
+        - bug
+    - title: 🏭 Refactor
+      labels:
+        - refactor
+        - maintenance
+    - title: 📝 Documentation
+      labels:
+        - documentation

async_kernel-0.1.0rc0/.github/workflows/ci.yml

@@ -0,0 +1,81 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+jobs:
+  pre-commit:
+    name: Pre-commit
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+      - uses: pre-commit/action@v3.0.1
+  test:
+    needs: pre-commit
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version:
+          - "3.11"
+          - "3.12"
+          - "3.13"
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          version: "latest"
+          python-version: ${{ matrix.python-version }}
+      - name: Checkout
+        uses: actions/checkout@v5
+
+      - name: Install the project
+        run: uv sync --locked --dev
+
+      - name: Run tests
+        timeout-minutes: 5
+        run: uv run pytest -vvl
+
+      - name: Type checking with basedpyright
+        run: uv run basedpyright
+
+  coverage:
+    needs: pre-commit
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          version: "latest"
+
+      - name: Run tests with coverage
+        timeout-minutes: 5
+        run: uv run pytest --cov --cov-fail-under=100
+
+  docs:
+    needs: pre-commit
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          version: "latest"
+
+      - name: Docs build strict
+        timeout-minutes: 5
+        run: |
+          uv sync --group docs
+          uv run async-kernel -a async-docs --shell.execute_request_timeout 0.1          
+          uv run mkdocs build -s

async_kernel-0.1.0rc0/.github/workflows/enforce-label.yml

@@ -0,0 +1,17 @@
+name: Enforce PR label
+
+concurrency:
+  group: label-${{ github.ref }}
+  cancel-in-progress: true
+
+on:
+  pull_request:
+    types: [labeled, unlabeled, opened, edited, synchronize]
+jobs:
+  enforce-label:
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+    steps:
+      - name: enforce-triage-label
+        uses: jupyterlab/maintainer-tools/.github/actions/enforce-label@v1

async_kernel-0.1.0rc0/.github/workflows/new_release.yml

@@ -0,0 +1,51 @@
+name: New release
+# Use this workflow to create a PR with updated release notes and labelled accordingly
+# See contributing.md for further detail.
+run-name: ${{ github.actor }} is starting a new release 🚀
+on:
+  workflow_dispatch:
+    inputs:
+      release_version:
+        description: "Version"
+        default: "v0.1.0-rc0"
+
+jobs:
+  changelog:
+    name: Generate changelog
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+          ref: main
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          version: "latest"
+
+      - name: Generate changelog
+        timeout-minutes: 5
+        run: |
+          git checkout -b release-${{ github.event.inputs.release_version}}
+          uvx git-cliff -o CHANGELOG.md --github-repo ${{ github.repository }} --github-token ${{ secrets.GITHUB_TOKEN }} --tag ${{ github.event.inputs.release_version}}
+          uvx git-cliff -o release_info.md --github-repo ${{ github.repository }} --github-token ${{ secrets.GITHUB_TOKEN }} --tag ${{ github.event.inputs.release_version}} --latest
+
+          git config user.name ${{github.triggering_actor}}
+          git config user.email ''
+          git add CHANGELOG.md
+          git commit -m "Release ${{ github.event.inputs.release_version}}"
+          git tag ${{ github.event.inputs.release_version}} -m "Release ${{ github.event.inputs.release_version}}"
+
+      - name: Create pull request
+        # ref: https://cli.github.com/manual/gh_pr_create
+        run: gh pr create --head changelog --title '${{github.event.inputs.release_version}}' --label release  --body-file release_info.md
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Push the changelog
+        run: git push  https://${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git  --tags

async_kernel-0.1.0rc0/.github/workflows/publish-docs.yml

@@ -0,0 +1,40 @@
+name: Publish docs
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+permissions:
+  contents: write
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          version: "latest"
+      - name: Checkout
+        uses: actions/checkout@v5
+
+      - name: Install the project
+        run: |
+          uv sync --group docs
+          uv run async-kernel -a async-docs --shell.execute_request_timeout 0.1
+          echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }} # cach_id is written above
+          path: ~/.cache
+          restore-keys: |
+            mkdocs-material-
+      - run: uv run mkdocs gh-deploy --force

async_kernel-0.1.0rc0/.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,81 @@
+name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI
+# ref: https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+    outputs:
+      tag: ${{ steps.tag_info.outputs.tag }}
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          persist-credentials: false
+          # Fetch full history for setuptools-scm
+          fetch-depth: 0
+          ref: main
+      - uses: astral-sh/setup-uv@v6
+      - name: Build a binary wheel and a source tarball
+        run: uv build
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+      - id: tag_info
+        name: Tag info
+        run: echo "tag=$(git tag --points-at HEAD)" >> $GITHUB_OUTPUT
+
+  publish-to-pypi:
+    name: >-
+      Publish Python 🐍 distribution 📦 to PyPI
+    needs:
+      - build
+    runs-on: ubuntu-latest
+    if: ${{startsWith(needs.build.outputs.tag, 'v')}}
+    environment:
+      name: pypi
+      url: https://pypi.org/p/async-kernel
+    permissions:
+      id-token: write # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v5
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+      - name: Create release on Github
+        run: gh release create ${{needs.build.outputs.tag}} './dist#release' --notes-from-tag
+
+  publish-to-testpypi:
+    name: Publish Python 🐍 distribution 📦 to TestPyPI
+    if: github.event_name == 'push'
+    needs:
+      - build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/async-kernel
+
+    permissions:
+      id-token: write # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v5
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish distribution 📦 to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/

async_kernel-0.1.0rc0/.gitignore

@@ -0,0 +1,14 @@
+build
+cover
+dist
+site
+*.py[co]
+__pycache__
+*.egg-info
+*.bak
+.ipynb_checkpoints
+.coverage
+.cache
+data_kernelspec
+.pytest_cache
+_version.py

async_kernel-0.1.0rc0/.pre-commit-config.yaml

@@ -0,0 +1,88 @@
+ci:
+  autoupdate_commit_msg: "chore: update pre-commit hooks"
+  autoupdate_schedule: weekly
+
+exclude: CHANGELOG.md
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-case-conflict
+      - id: check-ast
+      - id: check-docstring-first
+      - id: check-executables-have-shebangs
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: mixed-line-ending
+      - id: check-yaml
+        args: ["--unsafe"]
+      - id: debug-statements
+      - id: end-of-file-fixer
+
+  - repo: https://gitlab.com/bmares/check-json5
+    rev: v1.0.0
+    hooks:
+      - id: check-json5
+
+  - repo: https://github.com/python-jsonschema/check-jsonschema
+    rev: 0.33.3
+    hooks:
+      - id: check-github-workflows
+
+  - repo: https://github.com/executablebooks/mdformat
+    rev: 0.7.22
+    hooks:
+      - id: mdformat
+        additional_dependencies:
+          - mdformat-gfm
+          - mdformat-frontmatter
+          - mdformat-footnote
+          - mdformat-mkdocs
+
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: "v4.0.0-alpha.8"
+    hooks:
+      - id: prettier
+        types_or: [yaml, html, json]
+
+  - repo: https://github.com/adamchainz/blacken-docs
+    rev: "1.19.1"
+    hooks:
+      - id: blacken-docs
+        additional_dependencies: [black==23.7.0]
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: "v2.4.1"
+    hooks:
+      - id: codespell
+        args: ["-L", "sur,nd"]
+
+  - repo: https://github.com/pre-commit/pygrep-hooks
+    rev: "v1.10.0"
+    hooks:
+      - id: rst-backticks
+      - id: rst-directive-colons
+      - id: rst-inline-touching-normal
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.9
+    hooks:
+      - id: ruff
+        types_or: [python, jupyter]
+        args: ["--fix", "--show-fixes"]
+      - id: ruff-format
+        types_or: [python, jupyter]
+
+  - repo: https://github.com/scientific-python/cookie
+    rev: "2025.05.02"
+    hooks:
+      - id: sp-repo-review
+        additional_dependencies: ["repo-review[cli]"]
+
+  - repo: https://github.com/kynan/nbstripout
+    rev: "0.8.1"
+    hooks:
+      - id: nbstripout

async_kernel-0.1.0rc0/.vscode/launch.json

@@ -0,0 +1,31 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Python: Debug Tests",
+      "type": "debugpy",
+      "request": "launch",
+      "program": "${file}",
+      "purpose": ["debug-test"],
+      "console": "integratedTerminal",
+      "justMyCode": false, // Change as required. Note only one test config will work Ref: https://code.visualstudio.com/docs/python/testing#_debug-tests
+      "subProcess": true // Set this to false when debugging inside test_debugger.py
+    },
+    {
+      "name": "Python: Current File",
+      "type": "debugpy",
+      "request": "launch",
+      "program": "${file}",
+      "console": "integratedTerminal",
+      "cwd": "${workspaceFolder}",
+      "env": {
+        "PYTHONPATH": "${workspaceFolder}"
+      },
+      "justMyCode": true,
+      "args": ["-X dev", "Wd"]
+    }
+  ]
+}

async_kernel-0.1.0rc0/.vscode/settings.json

@@ -0,0 +1,22 @@
+{
+  "python.testing.pytestArgs": ["tests"],
+  "python.testing.unittestEnabled": false,
+  "python.testing.pytestEnabled": true,
+  "python.analysis.typeCheckingMode": "off",
+  "editor.defaultFormatter": "charliermarsh.ruff",
+  "basedpyright.analysis.diagnosticMode": "workspace",
+  "yaml.schemas": {
+    "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
+  },
+  "yaml.customTags": [
+    "!ENV scalar",
+    "!ENV sequence",
+    "!relative scalar",
+    "tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg",
+    "tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji",
+    "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format",
+    "tag:yaml.org,2002:python/object/apply:pymdownx.slugs.slugify mapping"
+  ],
+  "spellright.language": ["en"],
+  "spellright.documentTypes": ["markdown", "plaintext"]
+}

async_kernel-0.1.0rc0/.vscode/spellright.dict

@@ -0,0 +1,10 @@
+basedpyright
+uv
+Jupyter
+anyio
+asyncio
+zmq
+IPyKernel
+anyio's
+Asyc
+Jupyterlab

async_kernel-0.1.0rc0/CHANGELOG.md

@@ -0,0 +1,36 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0-rc0] - 2025-08-23
+
+### <!-- 1 --> 🚀 Features
+
+- Switch to vcs for versioning. [#2](https://github.com/fleming79/async-kernel/pull/2)
+
+### <!-- 2 --> 🐛 Fixes
+
+- Use no-local-version in pyproject.toml instead. [#5](https://github.com/fleming79/async-kernel/pull/5)
+
+- Use no-local-version on ci. [#4](https://github.com/fleming79/async-kernel/pull/4)
+
+### <!-- 5 --> 📝 Documentation
+ 
+
+- Revise changelog template. [#12](https://github.com/fleming79/async-kernel/pull/12)
+
+- Do changelog as PR instead of push to main. [#8](https://github.com/fleming79/async-kernel/pull/8)
+
+- Git cliff [#7](https://github.com/fleming79/async-kernel/pull/7)
+
+- Fix mkdocs publishing [#6](https://github.com/fleming79/async-kernel/pull/6)
+
+### <!-- 6 --> 🌀 Miscellaneous
+
+- Bump the actions group across 1 directory with 2 updates [#3](https://github.com/fleming79/async-kernel/pull/3)
+
+
+<!-- generated by git-cliff -->

async_kernel-0.1.0rc0/CONTRIBUTING.md

@@ -0,0 +1,109 @@
+# Contributing
+
+This project is under active development. Feel free to create an issue to provide feedback.
+
+## Development
+
+## Installation from source
+
+```shell
+git clone https://github.com/fleming79/async-kernel.git
+cd async-kernel
+uv venv -p python@311
+uv sync
+# Activate the environment
+```
+
+### update packages
+
+```shell
+uv lock --upgrade
+```
+
+## Running tests
+
+```shell
+uv run pytest
+```
+
+## Running tests with coverage
+
+We are aiming for 100% code coverage on CI (Linux). Any new code should also update tests to maintain coverage.
+
+```shell
+uv run pytest -vv --cov
+```
+
+## Code Styling
+
+`Async kernel` uses ruff for code formatting. The pre-commit hook should take care of how it should look.
+
+To install `pre-commit`, run the following:
+
+```shell
+pip install pre-commit
+pre-commit install
+```
+
+You can invoke the pre-commit hook by hand at any time with:
+
+```shell
+pre-commit run
+```
+
+## Type checking
+
+Type checking is performed using [basedpyright](https://docs.basedpyright.com/).
+
+```shell
+basedpyright
+```
+
+## Documentation
+
+Documentation is provided my [Material for MkDocs ](https://squidfunk.github.io/mkdocs-material/). To start up a server for editing locally:
+
+### Install
+
+```shell
+uv sync --group docs
+uv run async-kernel -a async-docs --shell.execute_request_timeout 0.1
+```
+
+### Serve locally
+
+```shell
+mkdocs serve 
+```
+
+### API / Docstrings
+
+API documentation is included using [mkdocstrings](https://mkdocstrings.github.io/).
+
+Docstrings are written in docstring format [google-notypes](https://mkdocstrings.github.io/griffe/reference/docstrings/?h=google#google-style).
+Typing information is included automatically by [griff](https://mkdocstrings.github.io/griffe).
+
+#### See also
+
+- [cross-referencing](https://mkdocstrings.github.io/usage/#cross-references)
+
+### Notebooks
+
+Notebooks are included in the documentation with the plugin [mkdocs-jupyter](https://github.com/danielfrg/mkdocs-jupyter).
+
+#### Useful links
+
+These links are not relevant for docstrings.
+
+- [footnotes](https://squidfunk.github.io/mkdocs-material/reference/footnotes/#usage)
+- [tooltips](https://squidfunk.github.io/mkdocs-material/reference/tooltips/#usage)
+
+### Deploy manually
+
+```shell
+mkdocs gh-deploy --force
+```
+
+## Releasing Async kernel
+
+TODO

async_kernel-0.1.0rc0/LICENSE

@@ -0,0 +1,55 @@
+MIT License
+
+Copyright (c) 2025 Alan Fleming.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished 
+to do so, subject to the following conditions:
+
+The above copyright notice, the below IPython license and this permission notice 
+shall be included in all copies or substantial portions of the Software.
+
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+
+IPython license
+BSD 3-Clause License
+
+Copyright (c) 2015, IPython Development Team
+
+All rights reserved.
+
+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.