diff options
Diffstat (limited to 'features/src/python/README.md')
| -rw-r--r-- | features/src/python/README.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/features/src/python/README.md b/features/src/python/README.md new file mode 100644 index 0000000..2dd092a --- /dev/null +++ b/features/src/python/README.md @@ -0,0 +1,44 @@ + +# Python (python) + +Installs the provided version of Python, as well as PIPX, and other common Python utilities. JupyterLab is conditionally installed with the python feature. Note: May require source code compilation. + +## Example Usage + +```json +"features": { + "ghcr.io/devcontainers/features/python:1": {} +} +``` + +## Options + +| Options Id | Description | Type | Default Value | +|-----|-----|-----|-----| +| version | Select a Python version to install. | string | os-provided | +| installTools | Install common Python tools like pylint | boolean | true | +| optimize | Optimize Python for performance when compiled (slow) | boolean | false | +| installPath | The path where python will be installed. | string | /usr/local/python | +| installJupyterlab | Install JupyterLab, a web-based interactive development environment for notebooks | boolean | false | +| configureJupyterlabAllowOrigin | Configure JupyterLab to accept HTTP requests from the specified origin | string | - | +| httpProxy | Connect to GPG keyservers using a proxy for fetching source code signatures by configuring this option | string | - | + +## Customizations + +### VS Code Extensions + +- `ms-python.python` +- `ms-python.vscode-pylance` + + + +## OS Support + +This Feature should work on recent versions of Debian/Ubuntu-based distributions with the `apt` package manager installed. + +`bash` is required to execute the `install.sh` script. + + +--- + +_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/devcontainers/features/blob/main/src/python/devcontainer-feature.json). Add additional notes to a `NOTES.md`._ |