Skip to main content

Fish kernel for Jupyter

Project description

Fish Kernel for Jupyter

fish-kernel is a Jupyter kernel implementation for the fish shell.

Requirements

  • Python >=3.10
  • fish command available on PATH
  • Jupyter frontend (jupyterlab or notebook)
  • Supported OS: Linux, macOS
  • Native Windows is not supported (fish shell dependency)

Install

PyPI

pip install fish-kernel

After installation, register the kernelspec.

fish-kernel install requires one of --user, --sys-prefix, or --prefix.

Install for your user account:

fish-kernel install --user

Or install into the current Python environment:

fish-kernel install --sys-prefix

After installation, verify the kernel is registered:

jupyter kernelspec list

You should see a fish kernel entry.

Development

git clone https://github.com/eunos-1128/fish-kernel.git
cd fish-kernel
uv sync --dev
uv run pytest
uv run fish-kernel install --sys-prefix
uv run jupyter kernelspec list

Documentation

Build docs locally with Sphinx + Furo:

uv sync --dev
uv run sphinx-build -b html docs docs/_build/html

Usage examples

Simple calculation:

set a 7
set b 13
math $a + $b

Acknowledgements

This project was developed with inspiration from:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fish_kernel-1.0.0.tar.gz (42.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fish_kernel-1.0.0-py3-none-any.whl (40.8 kB view details)

Uploaded Python 3

File details

Details for the file fish_kernel-1.0.0.tar.gz.

File metadata

  • Download URL: fish_kernel-1.0.0.tar.gz
  • Upload date:
  • Size: 42.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for fish_kernel-1.0.0.tar.gz
Algorithm Hash digest
SHA256 f2ac837c733cb0be8e78ac35be12f0344939b056eb54443ff400b84feb7f7ab1
MD5 1ad37ebb211c0896d0d4c8047ca89409
BLAKE2b-256 000927782be4f61f0f4780989e5a53a124ed0b888e98c0a22228a601fb012a23

See more details on using hashes here.

File details

Details for the file fish_kernel-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: fish_kernel-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 40.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for fish_kernel-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 400f1f578ed24f227f5c373a237112ae80984cf38179f79380611ddd2ccd704b
MD5 8406999c429f2f55df8df88ca0585f8b
BLAKE2b-256 9eae20a2dc04572eac206380bf15062fac32ccab2672170e2b6890091b96e7cf

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page