Skip to content

Add instructions on how to use the dev container image from GHCR #1581

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

brettcannon
Copy link
Member

@brettcannon brettcannon commented Jun 18, 2025

Along the way make using the container outside of GitHub Codespaces its own section.


📚 Documentation preview 📚: https://cpython-devguide--1581.org.readthedocs.build/

Along the way make using the container outside of GitHub Codespaces its own section.
Copy link
Collaborator

@willingc willingc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool! I appreciate this addition @brettcannon.

Copy link
Member

@encukou encukou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

Comment on lines +1215 to +1222

You can download the latest version of the container image via:

.. code-block:: bash

docker pull ghcr.io/python/devcontainer:latest

(Substitute ``podman`` for ``docker`` if you use Podman.)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

docker run will pull the image automatically, so this isn't necessary.

Suggested change
You can download the latest version of the container image via:
.. code-block:: bash
docker pull ghcr.io/python/devcontainer:latest
(Substitute ``podman`` for ``docker`` if you use Podman.)

.. code-block:: bash

podman run -it --rm --volume $PWD:/workspace:Z --workdir /workspace ghcr.io/python/devcontainer:latest

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you mean to copy the caveats here?

Suggested change
Note that the container has read/write access to the working directory.
You may want to use a separate clone of CPython, or run ``make clean``
to remove caches and build output generated for your host OS.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants