This image is designed to supercede the legacy CircleCI Python image, circleci/python.

cimg/python is a Docker image created by CircleCI with continuous integration builds in mind. Each tag contains a complete Python version via pyenv. pip, pipenv, and poetry are pre-installed, and any binaries and tools that are required for builds to complete successfully in a CircleCI environment.

Table of Contents

• Getting Started
• How This Image Works
• Development
• Contributing
• Additional Resources
• License

Getting Started

This image can be used with the CircleCI docker executor. For example:

jobs:
  build:
    docker:
      - image: cimg/python:3.8
    steps:
      - checkout
      - run: python --version

In the above example, the CircleCI Python Docker image is used as the primary container. More specifically, the tag 3.8 is used meaning the version of Python will be Python v3.8. You can now use Python within the steps for this job.

How This Image Works

This image contains the Python programming language as well as pip, pipenv, and poetry. The interpreter is provided via pyenv allowing you to change the Python version during a build as well.

Variants

Variant images typically contain the same base software, but with a few additional modifications.

Node.js

The Node.js variant is the same Python image but with Node.js also installed. The Node.js variant can be used by appending -node to the end of an existing cimg/python tag.

jobs:
  build:
    docker:
      - image: cimg/python:3.7-node
    steps:
      - checkout
      - run: python --version
      - run: node --version

Browsers

The browsers variant is the same Python image but with Node.js, Java, Selenium, and browser dependencies pre-installed via apt. The browsers variant can be used by appending -browser to the end of an existing cimg/python tag. The browsers variant is designed to work in conjunction with the CircleCI Browser Tools orb. You can use the orb to install a version of Google Chrome and/or Firefox into your build. The image contains all of the supporting tools needed to use both the browser and its driver.

orbs:
  browser-tools: circleci/[email protected]

jobs:
  build:
    docker:
      - image: cimg/python:3.7-browsers
    steps:
      - browser-tools/install-browser-tools
      - checkout
      - run: |
          python --version
          node --version
          java --version
          google-chrome --version

Tagging Scheme

This image has the following tagging scheme:

cimg/python:<python-version>[-variant]

<python-version> - The version of Python to use. This can be a full SemVer point release (such as 3.8.1) or just the minor release (such as 3.8). If you use the minor release tag, it will automatically point to future patch updates as they are released by the Python project. For example, the tag 3.8 points to Python v3.8.5 now, but when the next release comes out, it will point to Python v3.8.6.

[-variant] - Variant tags, if available, can optionally be used. For example, the Node.js variant could be used like this: cimg/python:3.7-node.

Development

Images can be built and run locally with this repository. This has the following requirements:

• local machine of Linux (Ubuntu tested) or macOS
• modern version of Bash (v4+)
• modern version of Docker Engine (v19.03+)

Cloning For Community Users (no write access to this repository)

Fork this repository on GitHub. When you get your clone URL, you'll want to add --recurse-submodules to the clone command in order to populate the Git submodule contained in this repo. It would look something like this:

git clone --recurse-submodules <my-clone-url>

If you missed this step and already cloned, you can just run git submodule update --recursive to populate the submodule. Then you can optionally add this repo as an upstream to your own:

git remote add upstream https://github.com/CircleCI-Public/cimg-python.git

Cloning For Maintainers ( you have write access to this repository)

Clone the project with the following command so that you populate the submodule:

git clone --recurse-submodules [email protected]:CircleCI-Public/cimg-python.git

Generating Dockerfiles

Dockerfiles can be generated for a specific Python version using the gen-dockerfiles.sh script. For example, to generate the Dockerfile for Python v3.7.7, you would run the following from the root of the repo:

./shared/gen-dockerfiles.sh 3.7.7

The generated Dockerfile will be located at ./3.7/Dockefile. To build this image locally and try it out, you can run the following:

cd 3.7
docker build -t test/python:3.7.7 .
docker run -it test/python:3.7.7 bash

Building the Dockerfiles

To build the Docker images locally as this repository does, you'll want to run the build-images.sh script:

./build-images.sh

This would need to be run after generating the Dockerfiles first. When releasing proper images for CircleCI, this script is run from a CircleCI pipeline and not locally.

Submitting a Pull Request

Ensure all the changes to the versioned Dockerfiles and the build-images.sh have been reverted, leaving only the Dockerfile.template as the modified file. These will have been modified while testing with the sections above. The specific versions will be included when the images are released.

Publishing Official Images (for Maintainers only)

The individual scripts (above) can be used to create the correct files for an image, and then added to a new git branch, committed, etc. A release script is included to make this process easier. To make a proper release for this image, let's use the fake Python version of v99.9.9, you would run the following from the repo root:

./shared/release.sh 99.9.9

This will automatically create a new Git branch, generate the Dockerfile(s), stage the changes, commit them, and push them to GitHub. The commit message will end with the string [release]. This string is used by CircleCI to know when to push images to Docker Hub. All that would need to be done after that is:

• wait for build to pass on CircleCI
• review the PR
• merge the PR

The main branch build will then publish a release.

Incorporating Changes

How changes are incorporated into this image depends on where they come from.

build scripts - Changes within the ./shared submodule happen in its own repository. For those changes to affect this image, the submodule needs to be updated. Typically like this:

cd shared
git pull
cd ..
git add shared
git commit -m "Updating submodule for foo."

parent image - By design, when changes happen to a parent image, they don't appear in existing Python images. This is to aid in "determinism" and prevent breaking customer builds. New Python images will automatically pick up the changes.

If you really want to publish changes from a parent image into the Python image, you have to build a specific image version as if it was a new image. This will create a new Dockerfile and once published, a new image.

Python specific changes - Editing the Dockerfile.template file in this repo is how to modify the Python image specifically. Don't forget that to see any of these changes locally, the gen-dockerfiles.sh script will need to be run again (see above).

Contributing

We encourage issues to and pull requests against this repository however, in order to value your time, here are some things to consider:

1. We won't include just anything in this image. In order for us to add a tool within the Python image, it has to be something that is maintained and useful to a large number of Pythonistas (Python developers). Every tool added makes the image larger and slower for all users so being thorough on what goes in the image will benefit everyone.
2. PRs are welcome. If you have a PR that will potentially take a large amount of time to make, it will be better to open an issue to discuss it first to make sure it's something worth investing the time in.
3. Issues should be to report bugs or request additional/removal of tools in this image. For help with images, please visit CircleCI Discuss.

Additional Resources

CircleCI Docs - The official CircleCI Documentation website. CircleCI Configuration Reference - From CircleCI Docs, the configuration reference page is one of the most useful pages we have. It will list all of the keys and values supported in .circleci/config.yml. Docker Docs - For simple projects this won't be needed but if you want to dive deeper into learning Docker, this is a great resource.

License

This repository is licensed under the MIT license. The license can be found here.