Skip to content

Commit 2aa35c6

Browse files
committed
python: Add note on pip install in slim variants
Add an image-specific slim variant section for Python. This overrides the default description of a slim variant. The image-specific description clarifies when `pip install` might fail in slim variants of the Python image.
1 parent cc489fa commit 2aa35c6

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

python/variant-slim.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
## `%%IMAGE%%:<version>-slim`
2+
3+
This image does not contain the common Debian packages contained in the default tag and only contains the minimal Debian packages needed to run `%%IMAGE%%`. Unless you are working in an environment where *only* the `%%IMAGE%%` image will be deployed and you have space constraints, we highly recommend using the default image of this repository.
4+
5+
When using this image `pip install` will work if a suitable built distribution is available for the Python distribution package being installed. `pip install` may fail when installing a Python distribution package from a source distribution. This image does not contain the Debian packages required to compile extension modules written in other languages. Possible solutions if a `pip install` fails include:
6+
7+
- Use this image and install any required Debian packages before running `pip install`.
8+
- Use the default image of this repository. The default image contains the most commonly required Debian packages. The majority of arbitrary `pip install`s should be successful without additional header/development Debian packages.

0 commit comments

Comments
 (0)