Provides a colorful CLI for basic Docker commands

Rich

Rich is a library designed to enahnce the printing of python applications, such as below:

rprint("Hello, [bold magenta]World[/bold magenta]!", ":vampire:", "TestMe")

Hello, World! 🧛 TestMe

We will use it to take very basic-looking docker commands, and Rich-ify them to look better

Docker

These are the docker commands currently supported, based on personal preference of use:

  • docker search
  • docker pull
  • docker run
  • docker container ls

create_docker_search_table[source]

create_docker_search_table(data, **args)

Returns a Table from a docker search query

Parameters:

  • data : <class 'inspect._empty'>

  • args : <class 'inspect._empty'>

Below you can see an example of a "docker_buddy" docker search result, utilizing Rich to improve the readability:

┏━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━┓
┃ Container Name            ┃ Description                    ┃ Stars ┃ Official ┃ Automated ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━┩
│ paperspace/fastai         │ Fast.ai course 2 [Pytorch]     │ 20    │          │           │
├───────────────────────────┼────────────────────────────────┼───────┼──────────┼───────────┤
│ spellrun/fastai           │                                │ 7     │          │           │
├───────────────────────────┼────────────────────────────────┼───────┼──────────┼───────────┤
│ deeprig/fastai-course-1   │ GPU-enabled Jupyter            │ 6     │          │ ✔         │
│                           │ environment for fast.ai …      │       │          │           │
├───────────────────────────┼────────────────────────────────┼───────┼──────────┼───────────┤
│ fastdotai/fastai          │ Official fast.ai image for     │ 6     │          │           │
│                           │ fastai                         │       │          │           │
├───────────────────────────┼────────────────────────────────┼───────┼──────────┼───────────┤
│ zerotosingularity/fastai2 │ This container has moved to    │ 2     │          │           │
│                           │ https://hub.dock…              │       │          │           │
├───────────────────────────┼────────────────────────────────┼───────┼──────────┼───────────┤
│ seemeai/fastai2           │ A Docker container for fastai  │ 2     │          │           │
│                           │ v2                             │       │          │           │
├───────────────────────────┼────────────────────────────────┼───────┼──────────┼───────────┤
│ zerotosingularity/fastai  │ This container has moved to    │ 2     │          │           │
│                           │ https://hub.dock…              │       │          │           │
├───────────────────────────┼────────────────────────────────┼───────┼──────────┼───────────┤
│ seemeai/fastai            │ A Docker container for fastai  │ 1     │          │           │
├───────────────────────────┼────────────────────────────────┼───────┼──────────┼───────────┤
│ fastai/fastai             │                                │ 1     │          │           │
├───────────────────────────┼────────────────────────────────┼───────┼──────────┼───────────┤
│ gwelican/fastai           │                                │ 1     │          │           │
├───────────────────────────┼────────────────────────────────┼───────┼──────────┼───────────┤
│ fastai/codespaces         │                                │ 1     │          │           │
├───────────────────────────┼────────────────────────────────┼───────┼──────────┼───────────┤
│ fastdotai/fastai-course   │                                │ 0     │          │           │
├───────────────────────────┼────────────────────────────────┼───────┼──────────┼───────────┤
│ spellrun/fastai-base      │                                │ 0     │          │           │
├───────────────────────────┼────────────────────────────────┼───────┼──────────┼───────────┤
│ fastai/ubuntu             │                                │ 0     │          │           │
├───────────────────────────┼────────────────────────────────┼───────┼──────────┼───────────┤
│ sgrestdocker/fastai       │ container for fastai code      │ 0     │          │           │
├───────────────────────────┼────────────────────────────────┼───────┼──────────┼───────────┤
│ fastai/fastpages-jekyll   │                                │ 0     │          │           │
├───────────────────────────┼────────────────────────────────┼───────┼──────────┼───────────┤
│ fastdotai/fastai-dev      │ Official fast.ai image for     │ 0     │          │           │
│                           │ fastai with an ed…             │       │          │           │
├───────────────────────────┼────────────────────────────────┼───────┼──────────┼───────────┤
│ aychang/fastai-gpu        │                                │ 0     │          │           │
├───────────────────────────┼────────────────────────────────┼───────┼──────────┼───────────┤
│ lifefilm/fastai2_fastapi  │ Fastai2, FastApi, Pytorch 1.7, │ 0     │          │           │
│                           │ Pipenv, Cond…                  │       │          │           │
├───────────────────────────┼────────────────────────────────┼───────┼──────────┼───────────┤
│ fastai/jekyll             │                                │ 0     │          │           │
├───────────────────────────┼────────────────────────────────┼───────┼──────────┼───────────┤
│ kuberlab/fastai           │                                │ 0     │          │           │
├───────────────────────────┼────────────────────────────────┼───────┼──────────┼───────────┤
│ krllerof/fastai           │                                │ 0     │          │           │
├───────────────────────────┼────────────────────────────────┼───────┼──────────┼───────────┤
│ grapenf/fastaindex        │                                │ 0     │          │           │
├───────────────────────────┼────────────────────────────────┼───────┼──────────┼───────────┤
│ qooba/fastai              │ fastai                         │ 0     │          │           │
├───────────────────────────┼────────────────────────────────┼───────┼──────────┼───────────┤
│ snarkai/fastai            │ Fast AI container              │ 0     │          │           │
└───────────────────────────┴────────────────────────────────┴───────┴──────────┴───────────┘

docker_search(TERM:"The name of a Docker image or namespace to search for", FILTER:"Filter output based on conditions provided"='', LIMIT:"Max number of search results (default 25)"=25, NO_TRUNC:"Don't truncate output"=False)

Search the Docker Hub for images

Parameters:

  • TERM : str <The name of a Docker image or namespace to search for>

  • FILTER : str <Filter output based on conditions provided>, optional

  • LIMIT : int <Max number of search results (default 25)>, optional

  • NO_TRUNC : <Don't truncate output>, optional

create_docker_ls_table[source]

create_docker_ls_table(data, **args)

Returns a Table from a docker search query

Parameters:

  • data : <class 'inspect._empty'>

  • args : <class 'inspect._empty'>

Below you can see an example of our supercharged docker ls output:

┏━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Container Nickname ┃ Image           ┃ Current Status ┃ Ports                             ┃
┡━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ nostalgic_golick   │ fastdotai/nbdev │ Up 2 hours     │ 0.0.0.0:8888->8888/tcp,           │
│                    │                 │                │ :::8888->8888/tcp                 │
└────────────────────┴─────────────────┴────────────────┴───────────────────────────────────┘

docker_container_ls[source]

docker_container_ls()

List containers

Bash Commands

Each of the prior functionalities have bash commands associated with them as follows:

This also helps with not overriding root Docker

Along with these, it is recommended to setup the following shortcuts in your bash_profile:

  • docker run -> dr
  • docker pull -> dp

So the naming conventions can remain similar (though there are no pretty tables/console bits for them)