1
1
# Docker image for ` pydocstyle `
2
2
3
- [ ![ Build Status] ( https://travis-ci.com/cytopia/docker-pydocstyle.svg?branch=master )] ( https://travis-ci.com/cytopia/docker-pydocstyle )
4
3
[ ![ Tag] ( https://img.shields.io/github/tag/cytopia/docker-pydocstyle.svg )] ( https://github.com/cytopia/docker-pydocstyle/releases )
5
- [ ![ ] ( https://images.microbadger.com/badges/version/cytopia/pydocstyle:latest.svg?&kill_cache=1 )] ( https://microbadger.com/images/cytopia/pydocstyle:latest " pydocstyle ")
6
- [ ![ ] ( https://images.microbadger.com/badges/image/cytopia/pydocstyle:latest.svg?&kill_cache=1 )] ( https://microbadger.com/images/cytopia/pydocstyle:latest " pydocstyle ")
7
- [ ![ ] ( https://img.shields.io/docker/pulls/cytopia/pydocstyle.svg )] ( https://hub.docker.com/r/cytopia/pydocstyle )
8
4
[ ![ ] ( https://img.shields.io/badge/github-cytopia%2Fdocker--pydocstyle-red.svg )] ( https://github.com/cytopia/docker-pydocstyle " github.com/cytopia/docker-pydocstyle ")
9
5
[ ![ License] ( https://img.shields.io/badge/license-MIT-%233DA639.svg )] ( https://opensource.org/licenses/MIT )
10
6
7
+ [ ![ lint] ( https://github.com/cytopia/docker-pydocstyle/workflows/lint/badge.svg )] ( https://github.com/cytopia/docker-pydocstyle/actions?query=workflow%3Alint )
8
+ [ ![ build] ( https://github.com/cytopia/docker-pydocstyle/workflows/build/badge.svg )] ( https://github.com/cytopia/docker-pydocstyle/actions?query=workflow%3Abuild )
9
+ [ ![ nightly] ( https://github.com/cytopia/docker-pydocstyle/workflows/nightly/badge.svg )] ( https://github.com/cytopia/docker-pydocstyle/actions?query=workflow%3Anightly )
10
+
11
+
11
12
> #### All [ #awesome-ci] ( https://github.com/topics/awesome-ci ) Docker images
12
13
>
13
- > [ ansible] [ ansible-git-lnk ] ** •**
14
14
> [ ansible-lint] [ alint-git-lnk ] ** •**
15
+ > [ ansible] [ ansible-git-lnk ] ** •**
15
16
> [ awesome-ci] [ aci-git-lnk ] ** •**
17
+ > [ bandit] [ bandit-git-lnk ] ** •**
16
18
> [ black] [ black-git-lnk ] ** •**
17
19
> [ checkmake] [ cm-git-lnk ] ** •**
18
20
> [ eslint] [ elint-git-lnk ] ** •**
21
23
> [ goimports] [ gimp-git-lnk ] ** •**
22
24
> [ golint] [ glint-git-lnk ] ** •**
23
25
> [ jsonlint] [ jlint-git-lnk ] ** •**
26
+ > [ kubeval] [ kubeval-git-lnk ] ** •**
27
+ > [ linkcheck] [ linkcheck-git-lnk ] ** •**
28
+ > [ mypy] [ mypy-git-lnk ] ** •**
29
+ > [ php-cs-fixer] [ pcsf-git-lnk ] ** •**
24
30
> [ phpcbf] [ pcbf-git-lnk ] ** •**
25
31
> [ phpcs] [ pcs-git-lnk ] ** •**
26
32
> [ phplint] [ plint-git-lnk ] ** •**
27
- > [ php-cs-fixer] [ pcsf-git-lnk ] ** •**
28
33
> [ pycodestyle] [ pycs-git-lnk ] ** •**
29
34
> [ pydocstyle] [ pyds-git-lnk ] ** •**
30
35
> [ pylint] [ pylint-git-lnk ] ** •**
31
36
> [ terraform-docs] [ tfdocs-git-lnk ] ** •**
32
- > [ terragrunt] [ tg-git-lnk ] ** •**
33
37
> [ terragrunt-fmt] [ tgfmt-git-lnk ] ** •**
38
+ > [ terragrunt] [ tg-git-lnk ] ** •**
34
39
> [ yamlfmt] [ yfmt-git-lnk ] ** •**
35
40
> [ yamllint] [ ylint-git-lnk ]
36
41
37
- > #### All [ #awesome-ci] ( https://github.com/topics/awesome-ci ) Makefiles
38
- >
39
- > 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-pydocstyle/blob/master/Dockerfiles/ ) ** on GitHub.
40
43
41
- View ** [ Dockerfile] ( https://github.com/cytopia/docker-pydocstyle/blob/master/Dockerfile ) ** on GitHub.
42
44
43
- [ ![ Docker hub ] ( http://dockeri.co/image/cytopia/pydocstyle?&kill_cache=1 )] ( https://hub.docker.com/r/cytopia/pydocstyle )
45
+ ** Available Architectures: ** ` amd64 ` , ` i386 ` , ` arm64 ` , ` arm/v7 ` , ` arm/v6 `
44
46
45
47
Tiny Alpine-based multistage-build dockerized version of [ pydocstyle] ( https://github.com/PyCQA/pydocstyle ) <sup >[ 1] </sup >.
46
48
The image is built nightly against multiple stable versions and pushed to Dockerhub.
47
49
48
50
<sup >[ 1] Official project: https://github.com/PyCQA/pydocstyle </sup >
49
51
52
+ ## :whale : Available Docker image versions
53
+
54
+ [ ![ ] ( https://img.shields.io/docker/pulls/cytopia/pydocstyle.svg )] ( https://hub.docker.com/r/cytopia/pydocstyle )
55
+ [ ![ Docker] ( https://badgen.net/badge/icon/:latest?icon=docker&label=cytopia/pydocstyle )] ( https://hub.docker.com/r/cytopia/pydocstyle )
56
+
57
+ #### Rolling releaess
58
+
59
+ The following Docker image tags are rolling releases and are built and updated every night.
60
+
61
+ [ ![ nightly] ( https://github.com/cytopia/docker-pydocstyle/workflows/nightly/badge.svg )] ( https://github.com/cytopia/docker-pydocstyle/actions?query=workflow%3Anightly )
62
+
63
+ | Docker Tag | Git Ref | PyDocStyle | Available Architectures |
64
+ | ----------------------| -----------| --------------| ----------------------------------------------|
65
+ | ` latest ` | master | latest | ` amd64 ` , ` i386 ` , ` arm64 ` , ` arm/v7 ` , ` arm/v6 ` |
66
+ | ` 6 ` | master | ** ` 6.x.x ` ** | ` amd64 ` , ` i386 ` , ` arm64 ` , ` arm/v7 ` , ` arm/v6 ` |
67
+ | ` 5 ` | master | ** ` 5.x.x ` ** | ` amd64 ` , ` i386 ` , ` arm64 ` , ` arm/v7 ` , ` arm/v6 ` |
68
+ | ` 4 ` | master | ** ` 4.x.x ` ** | ` amd64 ` , ` i386 ` , ` arm64 ` , ` arm/v7 ` , ` arm/v6 ` |
69
+ | ` 3 ` | master | ** ` 3.x.x ` ** | ` amd64 ` , ` i386 ` , ` arm64 ` , ` arm/v7 ` , ` arm/v6 ` |
70
+
71
+ #### Point in time releases
72
+
73
+ 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.
50
74
51
- ## Available Docker image versions
75
+ [ ![ build ] ( https://github.com/cytopia/docker-pydocstyle/workflows/build/badge.svg )] ( https://github.com/cytopia/docker-pydocstyle/actions?query=workflow%3Abuild )
52
76
53
- | Docker tag | Build from |
54
- | ------------| ------------|
55
- | ` latest ` | Latest stable pydocstyle version |
77
+ | Docker Tag | Git Ref | PyDocStyle | Available Architectures |
78
+ | ----------------------| --------------| --------------| ----------------------------------------------|
79
+ | ` latest-<tag> ` | tag: ` <tag> ` | latest | ` amd64 ` , ` i386 ` , ` arm64 ` , ` arm/v7 ` , ` arm/v6 ` |
80
+ | ` 6-<tag> ` | tag: ` <tag> ` | ** ` 6.x.x ` ** | ` amd64 ` , ` i386 ` , ` arm64 ` , ` arm/v7 ` , ` arm/v6 ` |
81
+ | ` 5-<tag> ` | tag: ` <tag> ` | ** ` 5.x.x ` ** | ` amd64 ` , ` i386 ` , ` arm64 ` , ` arm/v7 ` , ` arm/v6 ` |
82
+ | ` 4-<tag> ` | tag: ` <tag> ` | ** ` 4.x.x ` ** | ` amd64 ` , ` i386 ` , ` arm64 ` , ` arm/v7 ` , ` arm/v6 ` |
83
+ | ` 3-<tag> ` | tag: ` <tag> ` | ** ` 3.x.x ` ** | ` amd64 ` , ` i386 ` , ` arm64 ` , ` arm/v7 ` , ` arm/v6 ` |
56
84
85
+ > Where ` <tag> ` refers to the chosen git tag from this repository.
57
86
58
- ## Docker mounts
59
87
60
- The working directory inside the Docker container is ** ` /data/ ` ** and should be mounted locally to
61
- the root of your project where your ` setup.cfg ` or ` tox.ini ` config file is.
88
+ ## :open_file_folder : Docker mounts
62
89
90
+ The working directory inside the Docker container is ** ` /data/ ` ** and should be mounted locally.
63
91
64
- ## Usage
92
+
93
+ ## :computer : Usage
65
94
66
95
``` bash
67
96
docker run --rm -v $( pwd) :/data cytopia/pydocstyle .
68
97
```
69
98
70
99
71
- ## Related [ #awesome-ci] ( https://github.com/topics/awesome-ci ) projects
100
+ ## : arrows_counterclockwise : Related [ #awesome-ci] ( https://github.com/topics/awesome-ci ) projects
72
101
73
102
### Docker images
74
103
@@ -79,19 +108,23 @@ linter below for reproducible local or remote CI tests:
79
108
| --------| -----------| ------| -------------|
80
109
| [ awesome-ci] [ aci-git-lnk ] | [ ![ aci-hub-img]] [ aci-hub-lnk ] | Basic | Tools for git, file and static source code analysis |
81
110
| [ file-lint] [ flint-git-lnk ] | [ ![ flint-hub-img]] [ flint-hub-lnk ] | Basic | Baisc source code analysis |
111
+ | [ linkcheck] [ linkcheck-git-lnk ] | [ ![ linkcheck-hub-img]] [ flint-hub-lnk ] | Basic | Search for URLs in files and validate their HTTP status code |
82
112
| [ ansible] [ ansible-git-lnk ] | [ ![ ansible-hub-img]] [ ansible-hub-lnk ] | Ansible | Multiple versions and flavours of Ansible |
83
113
| [ ansible-lint] [ alint-git-lnk ] | [ ![ alint-hub-img]] [ alint-hub-lnk ] | Ansible | Lint Ansible |
84
114
| [ gofmt] [ gfmt-git-lnk ] | [ ![ gfmt-hub-img]] [ gfmt-hub-lnk ] | Go | Format Go source code ** <sup >[ 1] </sup >** |
85
115
| [ goimports] [ gimp-git-lnk ] | [ ![ gimp-hub-img]] [ gimp-hub-lnk ] | Go | Format Go source code ** <sup >[ 1] </sup >** |
86
116
| [ golint] [ glint-git-lnk ] | [ ![ glint-hub-img]] [ glint-hub-lnk ] | Go | Lint Go code |
87
117
| [ eslint] [ elint-git-lnk ] | [ ![ elint-hub-img]] [ elint-hub-lnk ] | Javascript | Lint Javascript code |
88
118
| [ jsonlint] [ jlint-git-lnk ] | [ ![ jlint-hub-img]] [ jlint-hub-lnk ] | JSON | Lint JSON files ** <sup >[ 1] </sup >** |
119
+ | [ kubeval] [ kubeval-git-lnk ] | [ ![ kubeval-hub-img]] [ kubeval-hub-lnk ] | K8s | Lint Kubernetes files |
89
120
| [ checkmake] [ cm-git-lnk ] | [ ![ cm-hub-img]] [ cm-hub-lnk ] | Make | Lint Makefiles |
90
121
| [ phpcbf] [ pcbf-git-lnk ] | [ ![ pcbf-hub-img]] [ pcbf-hub-lnk ] | PHP | PHP Code Beautifier and Fixer |
91
122
| [ phpcs] [ pcs-git-lnk ] | [ ![ pcs-hub-img]] [ pcs-hub-lnk ] | PHP | PHP Code Sniffer |
92
123
| [ phplint] [ plint-git-lnk ] | [ ![ plint-hub-img]] [ plint-hub-lnk ] | PHP | PHP Code Linter ** <sup >[ 1] </sup >** |
93
124
| [ php-cs-fixer] [ pcsf-git-lnk ] | [ ![ pcsf-hub-img]] [ pcsf-hub-lnk ] | PHP | PHP Coding Standards Fixer |
125
+ | [ bandit] [ bandit-git-lnk ] | [ ![ bandit-hub-img]] [ bandit-hub-lnk ] | Python | A security linter from PyCQA
94
126
| [ black] [ black-git-lnk ] | [ ![ black-hub-img]] [ black-hub-lnk ] | Python | The uncompromising Python code formatter |
127
+ | [ mypy] [ mypy-git-lnk ] | [ ![ mypy-hub-img]] [ mypy-hub-lnk ] | Python | Static source code analysis |
95
128
| [ pycodestyle] [ pycs-git-lnk ] | [ ![ pycs-hub-img]] [ pycs-hub-lnk ] | Python | Python style guide checker |
96
129
| [ pydocstyle] [ pyds-git-lnk ] | [ ![ pyds-hub-img]] [ pyds-hub-lnk ] | Python | Python docstyle checker |
97
130
| [ pylint] [ pylint-git-lnk ] | [ ![ pylint-hub-img]] [ pylint-hub-lnk ] | Python | Python source code, bug and quality checker |
@@ -111,6 +144,10 @@ linter below for reproducible local or remote CI tests:
111
144
[ flint-hub-img ] : https://img.shields.io/docker/pulls/cytopia/file-lint.svg
112
145
[ flint-hub-lnk ] : https://hub.docker.com/r/cytopia/file-lint
113
146
147
+ [ linkcheck-git-lnk ] : https://github.com/cytopia/docker-linkcheck
148
+ [ linkcheck-hub-img ] : https://img.shields.io/docker/pulls/cytopia/linkcheck.svg
149
+ [ linkcheck-hub-lnk ] : https://hub.docker.com/r/cytopia/linkcheck
150
+
114
151
[ jlint-git-lnk ] : https://github.com/cytopia/docker-jsonlint
115
152
[ jlint-hub-img ] : https://img.shields.io/docker/pulls/cytopia/jsonlint.svg
116
153
[ jlint-hub-lnk ] : https://hub.docker.com/r/cytopia/jsonlint
@@ -123,6 +160,10 @@ linter below for reproducible local or remote CI tests:
123
160
[ alint-hub-img ] : https://img.shields.io/docker/pulls/cytopia/ansible-lint.svg
124
161
[ alint-hub-lnk ] : https://hub.docker.com/r/cytopia/ansible-lint
125
162
163
+ [ kubeval-git-lnk ] : https://github.com/cytopia/docker-kubeval
164
+ [ kubeval-hub-img ] : https://img.shields.io/docker/pulls/cytopia/kubeval.svg
165
+ [ kubeval-hub-lnk ] : https://hub.docker.com/r/cytopia/kubeval
166
+
126
167
[ gfmt-git-lnk ] : https://github.com/cytopia/docker-gofmt
127
168
[ gfmt-hub-img ] : https://img.shields.io/docker/pulls/cytopia/gofmt.svg
128
169
[ gfmt-hub-lnk ] : https://hub.docker.com/r/cytopia/gofmt
@@ -159,10 +200,18 @@ linter below for reproducible local or remote CI tests:
159
200
[ pcsf-hub-img ] : https://img.shields.io/docker/pulls/cytopia/php-cs-fixer.svg
160
201
[ pcsf-hub-lnk ] : https://hub.docker.com/r/cytopia/php-cs-fixer
161
202
203
+ [ bandit-git-lnk ] : https://github.com/cytopia/docker-bandit
204
+ [ bandit-hub-img ] : https://img.shields.io/docker/pulls/cytopia/bandit.svg
205
+ [ bandit-hub-lnk ] : https://hub.docker.com/r/cytopia/bandit
206
+
162
207
[ black-git-lnk ] : https://github.com/cytopia/docker-black
163
208
[ black-hub-img ] : https://img.shields.io/docker/pulls/cytopia/black.svg
164
209
[ black-hub-lnk ] : https://hub.docker.com/r/cytopia/black
165
210
211
+ [ mypy-git-lnk ] : https://github.com/cytopia/docker-mypy
212
+ [ mypy-hub-img ] : https://img.shields.io/docker/pulls/cytopia/mypy.svg
213
+ [ mypy-hub-lnk ] : https://hub.docker.com/r/cytopia/mypy
214
+
166
215
[ pycs-git-lnk ] : https://github.com/cytopia/docker-pycodestyle
167
216
[ pycs-hub-img ] : https://img.shields.io/docker/pulls/cytopia/pycodestyle.svg
168
217
[ pycs-hub-lnk ] : https://hub.docker.com/r/cytopia/pycodestyle
@@ -202,7 +251,8 @@ Visit **[cytopia/makefiles](https://github.com/cytopia/makefiles)** for dependen
202
251
The provided Makefiles will only require GNU Make and Docker itself removing the need to install anything else.
203
252
204
253
205
- ## License
254
+ ## :page_facing_up : License
255
+
206
256
207
257
** [ MIT License] ( LICENSE ) **
208
258
0 commit comments