Manage Multiple Python Versions With Docker: an Alternative to Pyenv

UPDATED ON DEC 10, 2021 : 1191 words, 6 minute read β€” SOFTWARE DEVELOPMENT

You open a project to contribute code and quickly realize it requires a specific Python version you don’t have. Not only that, but it’s managing dependencies with some tool you don’t have, like Pipenv or Poetry. What are your options? You could spend a while setting up your machine with a fancy Python development environment , or you could get up and running right away using Docker as a Python version manager - which works the same across MacOS, Windows, and Linux .

Who is this for?

πŸ‘ Use this Docker strategy if you:

  • want a hassle-free way to develop on a project (such as an API or package) without fiddling with system setup.
  • Infrequently work on Python projects.

πŸ‘Ž Use the traditional setup with pyenv if you:

  • are confident in command line concepts like PATH, dot files, Python virtual environments, and your ability to fix any issues that might crop up.
  • Work with a large number of Python projects.

⚠️ If you’re trying to install a CLI tool or script written in Python, you’ll want to explore tools like Pipx . It’s possible to run scripts in containers, but I wouldn’t recommend for everyone.

Why use Docker as a Python version manager instead of Pyenv?

Why would you bother managing Python versions and environments with Docker when there are tools built to do it for you?

  • ⭐ Most developers don’t need a fancy Python set up. ⭐ In my experience, there are plenty of developers who just want to get up and running on a project rather than tinkering with their system config, especially if they rarely work with Python. Not everyone wants to play with dotfiles and development environments (😬 I do though, send me your tricks I love them). This approach only requires 1 Docker command.
  • Docker has a wide range of use cases, Pyenv has just one. Installing Docker to manage Python versions is just the tip of the iceberg of what it can do. Even if you decide you don’t like this approach, there will be other uses in the future. If you already have it installed, then one less step!
  • Avoiding tool maintenance. The combination of Pyenv + Pipenv/Poetry/etc. is usually a well-oiled machine. If an issue arises though, it can be frustrating to debug what’s wrong with your command line tools. The article you were copying setup commands from won’t be there when things breaks.

Enough chatter, now shut up and tell me how!

Manage multiple Python versions and environments with Docker

A prerequisite to managing Python versions with containers is to have either Docker or Podman installed on your machine. Once ready, follow the steps below:

#Step 1
git clone <your-repo>.git
cd <your-repo>
# Step 2 & 3: creates container that is destroyed after session
docker run -it --rm --name python-runner -v "$PWD":/usr/src/myapp -w /usr/src/myapp python:3.7 bash 

# OPTIONAL ALTERNATIVE> Step 2,3,& 3a: retain container between sessions
docker run -it --name <project-name> -v "$PWD":/usr/src/myapp -w /usr/src/myapp python:3.7 bash
# .... many hours later...
docker start -i <project-name>

# Step 4
# install dependencies following the directions based on your project

Explanation

  1. Clone the project you are trying to work with (not inside a container, we don’t want to deal with connecting to GitHub or IDEs from the container if we can help it. Keep it simple ).
  2. Choose the image version. Most common will be 3.6, 3.7, 3.8, 3.9, or 3.10 , but you can find every available option on Docker Hub . Your image will then be python:<chosen-version>.
  3. Use the docker run command to create a transient container (swap version if needed). The bash on the end, along with -it tells Docker to give us an interactive shell, just like when you open a new terminal prompt. The -v and -w make the current directory available inside the container, so you’ll need to always run this command from the project.
    • (Optional) - If you will be working with this project a lot, a couple small tweaks will let you reuse the same container. Give it a good --name that you will recognize and remove the --rm (which removes the container when the current run finishes). Now in the future, you can use docker start -i project-name to pop open the shell, rather than needing to create a brand new container and install dependencies again.
  4. Install dependencies following the instructions in next section.

Next step: managing dependencies

Now you’ve got a container running with the Python version the project needs, how can you handle required dependencies? You may need to install a tool inside your running container depending on how the project is configured, directions for the most common options are below. These commands should be run in the container shell created by the docker run command, not on your local system.

Pip (requirements.txt)

Nothing special needed here, run pip install --user -r requirement.txt and you’re off the the races.

Pipenv (Pipfile.lock)

Couple extra steps needed to get a Pipenv project running.

pip install --user pipenv
# Ensure tool is available in your container's PATH
echo "export PATH=~/.local/bin:$PATH" >> ~/.bashrc
. ~/.bashrc # equivalent to 'source ~/.bashrc'
pipenv install --dev

Poetry (poetry.lock)

Check the Poetry docs to ensure install command is up to date.

curl -sSL <https://install.python-poetry.org> | python3 -
# Ensure tool is available in your container's PATH
echo "export PATH=~/.local/bin:$PATH" >> ~/.bashrc
. ~/.bashrc # equivalent to 'source ~/.bashrc'
poetry install

FAQ

  • πŸ™‹ Does this take the place of virtualenv?
    • πŸ“£ Yes and no. You can use it that way (see Pip section above), but many projects will already use a tool like Pipenv for managing dependencies, which has virtual environments baked in. Docker adds an extra level of isolation in this case, but doesn’t replace the management of dependency versions, etc.
  • πŸ™‹ Can I still use my favorite IDE/text editor to edit files locally?
    • πŸ“£ Yes, all the files are still on your local machine since the container is using them with a volume mount.
  • πŸ™‹ Can I access any file on my system inside the Docker container?
    • πŸ“£ Only the original working directory will be attached inside your container, all the other files on system and in container are isolated from each other.
  • πŸ™‹ How do I access localhost if my Flask/Django/etc. app is running in a container?
    • πŸ“£ Docker isolates your code in a container separate from the rest of the system, so you’ll have to add an argument to the run command to expose the port. Something like -p 8080:80 -p 443:443 is the recommended route to map :. Read more on StackOverflow .
  • πŸ™‹ How do I install packages if my company blocks PyPi and has their own internal package repository?

Conclusion

This simpler approach to managing Python versions is another tool in your toolbox, and it can be applied for other languages as well. Hopefully you find success using this to get up and running on projects rather than fiddling with system configurations. Let me know if you have suggestions on ways to make it even simpler and improve it for future users.


See Also