instawork/python3-circleci

CircleCI 基础 Python 3 镜像文档

1. 镜像概述

本镜像为CircleCI平台设计，提供标准化的Python 3运行环境，旨在支持CI/CD流程中的Python项目构建、测试及部署等环节，确保开发流程的一致性和稳定性。

2. 核心功能与特性

• 预配置Python环境：内置Python 3解释器及基础依赖，无需手动安装核心运行环境
• CircleCI兼容性：针对CircleCI平台优化，支持与CircleCI工作流、缓存机制等功能无缝集成
• 轻量级设计：基于精简基础镜像构建，减少镜像体积，提升CI/CD流程执行效率
• 工具集成：包含pip、setuptools等常用Python包管理工具，简化依赖安装流程

3. 使用场景

• Python 3项目在CircleCI中的自动化构建流程
• Python单元测试、集成测试的批量执行
• Python依赖包的安装与项目打包（如生成wheel、sdist包）
• 基于Python的脚本执行（如代码静态分析、文档生成等辅助任务）

4. 使用方法与配置说明

4.1 在CircleCI配置中使用

通过CircleCI配置文件（.circleci/config.yml）指定本镜像，示例如下：

yaml
version: 2.1
jobs:
  python-ci-job:
    docker:
      - image: circleci/python:3.x  # 替换为具体Python版本标签，如3.9、3.10
    steps:
      - checkout  # 拉取代码仓库
      - run: python --version  # 验证Python环境版本
      - run: pip install -r requirements.txt  # 安装项目依赖
      - run: pytest tests/  # 执行测试用例
workflows:
  main-workflow:
    jobs:
      - python-ci-job

4.2 镜像标签说明

镜像标签对应Python版本，常用标签格式：

• circleci/python:3.9：Python 3.9版本
• circleci/python:3.10：Python 3.10版本
• circleci/python:3：最新稳定Python 3版本（自动指向最新 minor 版本）

4.3 环境变量与配置

可通过CircleCI配置中的environment字段设置自定义环境变量，示例：

yaml
jobs:
  python-ci-job:
    docker:
      - image: circleci/python:3.10
    environment:
      PYTHONPATH: "/home/circleci/project"  # 设置Python模块搜索路径
      PIP_NO_CACHE_DIR: "off"  # 启用pip缓存提升依赖安装速度
    steps:
      # 流程步骤...

4.4 依赖缓存配置

结合CircleCI缓存机制加速依赖安装，示例：

yaml
jobs:
  python-ci-job:
    docker:
      - image: circleci/python:3.10
    steps:
      - checkout
      - restore_cache:  # 恢复缓存的依赖
          keys:
            - v1-dependencies-{{ checksum "requirements.txt" }}
      - run: pip install -r requirements.txt
      - save_cache:  # 缓存依赖
          paths:
            - /home/circleci/.local/lib/python3.10/site-packages
          key: v1-dependencies-{{ checksum "requirements.txt" }}
      - run: pytest tests/