https://github.com/ssciwr/dockerfile-kernel

Docker kernel for Jupyter Lab
https://github.com/ssciwr/dockerfile-kernel

docker dockerfile jupyter jupyter-kernel jupyterlab

Last synced: about 2 months ago
JSON representation

Docker kernel for Jupyter Lab

• Host: GitHub
• URL: https://github.com/ssciwr/dockerfile-kernel
• Owner: ssciwr
• License: mit
• Created: 2023-05-16T07:35:48.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-08T15:37:11.000Z (12 months ago)
• Last Synced: 2024-04-14T09:49:06.041Z (9 months ago)
• Topics: docker, dockerfile, jupyter, jupyter-kernel, jupyterlab
• Language: Python
• Homepage:
• Size: 8.11 MB
• Stars: 3
• Watchers: 0
• Forks: 0
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: COPYING.md

Awesome Lists containing this project

README

        
# dockerfile-kernel

This implements a JupyterLab kernel to interpret Dockerfiles.

## Features

- Line-based execution of Dockerfiles in JupyterLab

- Conveniently launch shell sessions running in a container created from the current image by clicking on a button.

- Command auto-completion

- Syntax Highlighting

- Help text integration with the `?` operation

- Export and Import from Dockerfiles

- Custom magics for e.g.

  - Tag the current Docker image with `%tag myimage:latest`

  - Easily follow best practices of installation with `%install apt ` (will expand to a `RUN` command doing all the required setup and cleanup). Also implemented for `pip` and `npm`.

  - Manipulate build arguments with `%arg`

  - Get an overview of existing build stages with `%stages`

  - Manipulate the build context with `%context`

## Prerequisites

- Currently, only Linux is supported

- [Docker](https://docs.docker.com/engine/install/ubuntu/) needs to be installed

- The user needs to be in the `docker` group (see e.g. [here](https://askubuntu.com/a/739861))

- [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/getting_started/installation.html) >= 4.0.0 needs to be installed

## Installation

With pip:

```bash

python -m pip install dockerfile-kernel

python -m dockerfile_kernel.install

```

With conda (soon!):

```bash

conda install -c conda-forge dockerfile-kernel

```

#### Execution

`jupyter lab`