Sitelet https://github.com/cytopia/docker-mypy/commit/a7743bfbe817d8ab5226d42d0ffbd1eedd9bad0c
Skip to content

Commit a7743bf

Browse files
cytopiacytopia
committed
Update README
1 parent 158622d commit a7743bf

1 file changed

Lines changed: 44 additions & 20 deletions

File tree

‎README.md‎

Lines changed: 44 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
# Docker image for `mypy`
22

33
[![Tag](https://img.shields.io/github/tag/cytopia/docker-mypy.svg)](https://github.com/cytopia/docker-mypy/releases)
4-
[![](https://images.microbadger.com/badges/version/cytopia/mypy:latest.svg?kill_cache=1)](https://microbadger.com/images/cytopia/mypy:latest "mypy")
5-
[![](https://images.microbadger.com/badges/image/cytopia/mypy:latest.svg?kill_cache=1)](https://microbadger.com/images/cytopia/mypy:latest "mypy")
6-
[![](https://img.shields.io/docker/pulls/cytopia/mypy.svg)](https://hub.docker.com/r/cytopia/mypy)
74
[![](https://img.shields.io/badge/github-cytopia%2Fdocker--mypy-red.svg)](https://github.com/cytopia/docker-mypy "github.com/cytopia/docker-mypy")
85
[![License](https://img.shields.io/badge/license-MIT-%233DA639.svg)](https://opensource.org/licenses/MIT)
96

107
[![lint](https://github.com/cytopia/docker-mypy/workflows/lint/badge.svg)](https://github.com/cytopia/docker-mypy/actions?query=workflow%3Alint)
118
[![build](https://github.com/cytopia/docker-mypy/workflows/build/badge.svg)](https://github.com/cytopia/docker-mypy/actions?query=workflow%3Abuild)
129
[![nightly](https://github.com/cytopia/docker-mypy/workflows/nightly/badge.svg)](https://github.com/cytopia/docker-mypy/actions?query=workflow%3Anightly)
1310

11+
1412
> #### All [#awesome-ci](https://github.com/topics/awesome-ci) Docker images
1513
>
1614
> [ansible-lint][alint-git-lnk] **•**
@@ -41,50 +39,75 @@
4139
> [yamlfmt][yfmt-git-lnk] **•**
4240
> [yamllint][ylint-git-lnk]
4341
44-
> #### All [#awesome-ci](https://github.com/topics/awesome-ci) Makefiles
45-
>
46-
> Visit **[cytopia/makefiles](https://github.com/cytopia/makefiles)** for seamless project integration, minimum required best-practice code linting and CI.
42+
View **[Dockerfiles](https://github.com/cytopia/docker-mypy/blob/master/Dockerfiles/)** on GitHub.
4743

48-
View **[Dockerfile](https://github.com/cytopia/docker-mypy/blob/master/Dockerfile)** on GitHub.
4944

50-
[![Docker hub](http://dockeri.co/image/cytopia/mypy?&kill_cache=1)](https://hub.docker.com/r/cytopia/mypy)
45+
**Available Architectures:** `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6`
5146

5247
Tiny Alpine-based multistage-build dockerized version of [mypy](https://github.com/python/mypy)<sup>[1]</sup>.
5348
The image is built nightly against multiple stable versions and pushed to Dockerhub.
5449

5550
<sup>[1] Official project: https://github.com/python/mypy</sup>
5651

52+
## :whale: Available Docker image versions
5753

58-
## Available Docker image versions
54+
[![](https://img.shields.io/docker/pulls/cytopia/mypy.svg)](https://hub.docker.com/r/cytopia/mypy)
55+
[![Docker](https://badgen.net/badge/icon/:latest?icon=docker&label=cytopia/mypy)](https://hub.docker.com/r/cytopia/mypy)
5956

6057
#### Rolling releaess
6158

6259
The following Docker image tags are rolling releases and are built and updated every night.
6360

6461
[![nightly](https://github.com/cytopia/docker-mypy/workflows/nightly/badge.svg)](https://github.com/cytopia/docker-mypy/actions?query=workflow%3Anightly)
6562

66-
| Docker tag | Build from |
67-
|------------|------------|
68-
| `latest` | Latest stable mypy version |
63+
64+
| Docker Tag | Git Ref | mypy | Python | Available Architectures |
65+
|-----------------------|--------------|--------------|-------------|----------------------------------------------|
66+
| **`latest`** | master | latest | latest | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
67+
| `latest-py3.10` | master | latest | **`3.10`** | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
68+
| `latest-py3.9` | master | latest | **`3.9`** | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
69+
| `latest-py3.8` | master | latest | **`3.8`** | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
70+
| `latest-py3.7` | master | latest | **`3.7`** | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
71+
| `latest-py3.6` | master | latest | **`3.6`** | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
72+
| | | | | |
73+
| **`0`** | master | **`0.x.x`** | latest | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
74+
| `0-py3.10` | master | **`0.x.x`** | **`3.10`** | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
75+
| `0-py3.9` | master | **`0.x.x`** | **`3.9`** | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
76+
| `0-py3.8` | master | **`0.x.x`** | **`3.8`** | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
77+
| `0-py3.7` | master | **`0.x.x`** | **`3.7`** | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
78+
| `0-py3.6` | master | **`0.x.x`** | **`3.6`** | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
79+
6980

7081
#### Point in time releases
7182

7283
The following Docker image tags are built once and can be used for reproducible builds. Its version never changes so you will have to update tags in your pipelines from time to time in order to stay up-to-date.
7384

7485
[![build](https://github.com/cytopia/docker-mypy/workflows/build/badge.svg)](https://github.com/cytopia/docker-mypy/actions?query=workflow%3Abuild)
7586

76-
| Docker tag | Explanation |
77-
|-----------------|-------------|
78-
| `latest-<TAG>` | Latest stable version when this repository was git tagged |
87+
| Docker Tag | Git Ref | mypy | Python | Available Architectures |
88+
|-----------------------|--------------|--------------|-------------|----------------------------------------------|
89+
| **`latest-<tag>`** | git: `<tag>` | latest | latest | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
90+
| `latest-py3.10-<tag>` | git: `<tag>` | latest | **`3.10`** | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
91+
| `latest-py3.9-<tag>` | git: `<tag>` | latest | **`3.9`** | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
92+
| `latest-py3.8-<tag>` | git: `<tag>` | latest | **`3.8`** | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
93+
| `latest-py3.7-<tag>` | git: `<tag>` | latest | **`3.7`** | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
94+
| `latest-py3.6-<tag>` | git: `<tag>` | latest | **`3.6`** | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
95+
| | | | | |
96+
| **`0-<tag>`** | git: `<tag>` | **`1.x.x`** | latest | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
97+
| `0-py3.10-<tag>` | git: `<tag>` | **`1.x.x`** | **`3.10`** | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
98+
| `0-py3.9-<tag>` | git: `<tag>` | **`1.x.x`** | **`3.9`** | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
99+
| `0-py3.8-<tag>` | git: `<tag>` | **`1.x.x`** | **`3.8`** | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
100+
| `0-py3.6-<tag>` | git: `<tag>` | **`1.x.x`** | **`3.6`** | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
79101

102+
> Where `<tag>` refers to the chosen git tag from this repository.
80103
81-
## Docker mounts
82104

83-
The working directory inside the Docker container is **`/data/`** and should be mounted locally to
84-
the root of your project.
105+
## :open_file_folder: Docker mounts
85106

107+
The working directory inside the Docker container is **`/data/`** and should be mounted locally.
86108

87-
## Usage
109+
110+
## :computer: Usage
88111

89112
```bash
90113
# Linux, Mac, Windows (Powershell)
@@ -249,7 +272,8 @@ Visit **[cytopia/makefiles](https://github.com/cytopia/makefiles)** for dependen
249272
The provided Makefiles will only require GNU Make and Docker itself removing the need to install anything else.
250273

251274

252-
## License
275+
## :page_facing_up: License
276+
253277

254278
**[MIT License](LICENSE)**
255279

0 commit comments

Comments
 (0)