Skip to content

Commit

Permalink
Merge pull request #14 from FREVA-CLINT/update-readme
Browse files Browse the repository at this point in the history
Update README.
  • Loading branch information
antarcticrainforest authored Jul 8, 2024
2 parents 3e5ebe7 + 857b28f commit 402f5b3
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Changelog

All notable changes to this project will be documented in this file.
## [v2407.0.0]
## [v2407.0.1]
### Changed
- Renamed python module `kernel_install` -> `jupyter_kernel_install`

Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Install Kernel Specifications into userspace

[![PyPI version](https://badge.fury.io/py/jupyter-kernel-install.svg)](https://badge.fury.io/py/jupyter-kernel-install)
[![Pipeline](https://github.com/FREVA-CLINT/install-kernelspec/actions/workflows/ci_job.yml/badge.svg)](https://github.com/FREVA-CLINT/install-kernelspec/actions)
[![codecov](https://codecov.io/gh/FREVA-CLINT/install-kernelspec/graph/badge.svg?token=90RyY5I9AI)](https://codecov.io/gh/FREVA-CLINT/install-kernelspec)
[![BSD](https://anaconda.org/conda-forge/freva/badges/license.svg)](https://github.com/FREVA-CLINT/install-kernelspec/LICENSE)
Expand All @@ -10,7 +10,7 @@ of DKRZ.

## Installation
```python
python3 -m pip install kernel-install
python3 -m pip install jupyter-kernel-install
```

## Usage
Expand Down Expand Up @@ -50,15 +50,15 @@ The following kernel specifications are supported:
Example for installing a gnuR kernel:

```console
kernel-install r --name r-regiklim --display-name "R for Regiklim"
jupyter-kernel-install r --name r-regiklim --display-name "R for Regiklim"
```

### Using the python library

Example for programmatically installing a bash kernel:

```python
import kernel_install as ki
import jupyter_kernel_install as ki
kernel_path = ki.bash(name="bash-regiklim", display_name="bash kernel")
```

Expand Down
2 changes: 1 addition & 1 deletion src/jupyter_kernel_install/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,5 @@

from .install import bash, python, r

__version__ = "2407.0.0"
__version__ = "2407.0.1"
__all__ = ["bash", "r", "python"]

0 comments on commit 402f5b3

Please sign in to comment.