ssplatt/pycqa-tools

docker-pycqa-tools

Docker Hub: https://hub.docker.com/repository/docker/ssplatt/pycqa-tools

镜像概述

docker-pycqa-tools是将PyCQA（Python Code Quality Authority）工具打包成容器的镜像，主要用于CircleCI工作流中的代码质量检查。该镜像提供多个Python版本，每个版本包含特定的代码质量分析工具，方便在CI/CD流程中集成代码质量检测环节。

核心功能和特性

包含的工具集

• Python 2.7版本包含：

  • bandit（安全漏洞扫描）
  • pylint（代码分析器）
  • pep8（PEP 8风格检查）
  • pyflakes（语法错误检查）
  • flake8（代码风格检查）
  • mccabe（代码复杂度分析）
  • dodgy（安全问题检测）
  • pydocstyle（文档字符串检查）
  • pyroma（项目质量检查）
  • vulture（未使用代码检测）
  • deprecated.frosted（静态代码分析）

• Python 3.7版本包含：

  • prospector及所有模块（综合代码分析工具）

• Python 3.8版本包含：

  • prospector及所有模块（综合代码分析工具）

使用场景和适用范围

适用于需要在CircleCI工作流中集成代码质量检查的Python项目，可帮助开发团队在CI/CD流程中自动检测代码风格、安全漏洞、未使用代码等问题，提升代码质量和项目可维护性。支持Python 2.7、3.7、3.8环境的项目。

使用方法和配置说明

镜像标签说明

• ssplatt/pycqa-tools:2.7：Python 2.7版本，包含基础PyCQA工具
• ssplatt/pycqa-tools:3.7：Python 3.7版本，包含prospector及所有模块
• ssplatt/pycqa-tools:3.8：Python 3.8版本，包含prospector及所有模块

CircleCI配置示例

在.circleci/config.yml中配置使用该镜像：

yaml
version: 2.1

jobs:
  test:
    docker:
      - image: ssplatt/pycqa-tools:3.8  # 指定Python 3.8版本镜像
    working_directory: ~/repo
    steps:
      - checkout  # 检出代码
      - run:
          name: 使用prospector进行多工具代码分析
          command: |
            prospector \
              --with-tool pyroma \      # 启用pyroma工具（项目质量检查）
              --with-tool vulture \     # 启用vulture工具（未使用代码检测）
              --with-tool frosted \     # 启用frosted工具（静态代码分析）
              --with-tool mypy \        # 启用mypy工具（类型检查）
              --with-tool bandit        # 启用bandit工具（安全漏洞扫描）

workflows:
  version: 2
  default:
    jobs:
      - test  # 运行代码质量检查任务

直接运行容器（非CI环境）

可通过以下命令在本地直接运行容器进行代码质量检查：

bash
# 假设当前目录为项目根目录，使用Python 3.8版本镜像运行prospector
docker run -v $(pwd):/app -w /app docker.xuanyuan.run/ssplatt/pycqa-tools:3.8 prospector

注意事项

• 选择与项目Python版本匹配的镜像标签，避免工具兼容性问题
• prospector工具可通过--with-tool参数灵活启用不同分析工具，具体参数可参考https://prospector.readthedocs.io/
• 对于Python 2.7项目，直接使用对应工具命令（如pylint、flake8等），无需通过prospector调用