/docker-black

Alpine-based multistage-build version of Python Black for reproducible usage in CI

Primary LanguageRoffMIT LicenseMIT

Docker image for black

Tag Docker License

lint build nightly

All #awesome-ci Docker images

ansible-lint ansible awesome-ci bandit black checkmake eslint file-lint gofmt goimports golint jsonlint kubeval linkcheck mypy php-cs-fixer phpcbf phpcs phplint pycodestyle pydocstyle pylint terraform-docs terragrunt-fmt terragrunt yamlfmt yamllint

View Dockerfiles on GitHub.

Available Architectures: amd64, i386, arm64, arm/v7, arm/v6, ppc64le, s390x

Tiny Alpine-based multistage-build dockerized version of Black[1]. The image is built nightly against multiple stable versions and pushed to Dockerhub.

[1] Official project: https://github.com/python/black

:octocat: GitHub Action

Runs on:

To add this to GitHub Actions, add the following snippet into your .github/workflows/ directory:

.github/workflows/lint.yml

on: [push, pull_request]

jobs:
  python-black:
    name: Python Black
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Python Black
        uses: cytopia/docker-black@0.8
        with:
          path: 'src/'

🐳 Available Docker image versions

Docker

Rolling releaess

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

nightly

Docker Tag Git Ref Black Python Available Architectures
latest master latest latest amd64, i386, arm64, arm/v7, arm/v6
latest-py3.10 master latest 3.10 amd64, i386, arm64, arm/v7, arm/v6
latest-py3.9 master latest 3.9 amd64, i386, arm64, arm/v7, arm/v6
latest-py3.8 master latest 3.8 amd64, i386, arm64, arm/v7, arm/v6
latest-py3.7 master latest 3.7 amd64, i386, arm64, arm/v7, arm/v6
latest-py3.6 master latest 3.6 amd64, i386, arm64, arm/v7, arm/v6
22 master 22.x.x latest amd64, i386, arm64, arm/v7, arm/v6
22-py3.10 master 22.x.x 3.10 amd64, i386, arm64, arm/v7, arm/v6
22-py3.9 master 22.x.x 3.9 amd64, i386, arm64, arm/v7, arm/v6
22-py3.8 master 22.x.x 3.8 amd64, i386, arm64, arm/v7, arm/v6
22-py3.7 master 22.x.x 3.7 amd64, i386, arm64, arm/v7, arm/v6
22-py3.6 master 22.x.x 3.6 amd64, i386, arm64, arm/v7, arm/v6

Point in time releases

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.

build

Docker Tag Git Ref Black Python Available Architectures
latest-<tag> git: <tag> latest latest amd64, i386, arm64, arm/v7, arm/v6
latest-py3.10-<tag> git: <tag> latest 3.10 amd64, i386, arm64, arm/v7, arm/v6
latest-py3.9-<tag> git: <tag> latest 3.9 amd64, i386, arm64, arm/v7, arm/v6
latest-py3.8-<tag> git: <tag> latest 3.8 amd64, i386, arm64, arm/v7, arm/v6
latest-py3.7-<tag> git: <tag> latest 3.7 amd64, i386, arm64, arm/v7, arm/v6
latest-py3.6-<tag> git: <tag> latest 3.6 amd64, i386, arm64, arm/v7, arm/v6
22-<tag> git: <tag> 22.x.x latest amd64, i386, arm64, arm/v7, arm/v6
22-py3.10-<tag> git: <tag> 22.x.x 3.10 amd64, i386, arm64, arm/v7, arm/v6
22-py3.9-<tag> git: <tag> 22.x.x 3.9 amd64, i386, arm64, arm/v7, arm/v6
22-py3.8-<tag> git: <tag> 22.x.x 3.8 amd64, i386, arm64, arm/v7, arm/v6
22-py3.7-<tag> git: <tag> 22.x.x 3.7 amd64, i386, arm64, arm/v7, arm/v6
22-py3.6-<tag> git: <tag> 22.x.x 3.6 amd64, i386, arm64, arm/v7, arm/v6

Where <tag> refers to the chosen git tag from this repository.

📂 Docker mounts

The working directory inside the Docker container is /data/ and should be mounted locally.

💻 Usage

Command line

# Linux, Mac, Windows (Powershell)
docker run --rm -v $(pwd):/data cytopia/black main.py

# Windows (cmd)
docker run --rm -v %cd%:/data cytopia/black main.py

GitLab CI

stages:
 - format

format-black:
  stage: format
  image:
    name: cytopia/black
    entrypoint: ["/bin/ash", "-c"]
  script:
    - python3 -m black --check --diff my_source_files/

🔄 Related #awesome-ci projects

Docker images

Save yourself from installing lot's of dependencies and pick a dockerized version of your favourite linter below for reproducible local or remote CI tests:

GitHub DockerHub Type Description
awesome-ci aci-hub-img Basic Tools for git, file and static source code analysis
file-lint flint-hub-img Basic Baisc source code analysis
linkcheck linkcheck-hub-img Basic Search for URLs in files and validate their HTTP status code
ansible ansible-hub-img Ansible Multiple versions and flavours of Ansible
ansible-lint alint-hub-img Ansible Lint Ansible
gofmt gfmt-hub-img Go Format Go source code [1]
goimports gimp-hub-img Go Format Go source code [1]
golint glint-hub-img Go Lint Go code
eslint elint-hub-img Javascript Lint Javascript code
jsonlint jlint-hub-img JSON Lint JSON files [1]
kubeval kubeval-hub-img K8s Lint Kubernetes files
checkmake cm-hub-img Make Lint Makefiles
phpcbf pcbf-hub-img PHP PHP Code Beautifier and Fixer
phpcs pcs-hub-img PHP PHP Code Sniffer
phplint plint-hub-img PHP PHP Code Linter [1]
php-cs-fixer pcsf-hub-img PHP PHP Coding Standards Fixer
bandit bandit-hub-img Python A security linter from PyCQA
black black-hub-img Python The uncompromising Python code formatter
mypy mypy-hub-img Python Static source code analysis
pycodestyle pycs-hub-img Python Python style guide checker
pydocstyle pyds-hub-img Python Python docstyle checker
pylint pylint-hub-img Python Python source code, bug and quality checker
terraform-docs tfdocs-hub-img Terraform Terraform doc generator (TF 0.12 ready) [1]
terragrunt tg-hub-img Terraform Terragrunt and Terraform
terragrunt-fmt tgfmt-hub-img Terraform terraform fmt for Terragrunt files [1]
yamlfmt yfmt-hub-img Yaml Format Yaml files [1]
yamllint ylint-hub-img Yaml Lint Yaml files

[1] Uses a shell wrapper to add enhanced functionality not available by original project.

Makefiles

Visit cytopia/makefiles for dependency-less, seamless project integration and minimum required best-practice code linting for CI. The provided Makefiles will only require GNU Make and Docker itself removing the need to install anything else.

📄 License

MIT License

Copyright (c) 2019 cytopia