windpioneers/gdal-python repository overview

windpioneers/gdal-python:<release-name>-gdal-<gdal-version>-python-<python-version>-<build-mode>

FROM windpioneers/gdal-python:gdal-2.4.1-python-3.9-dev

# Tell zsh where you want to store history

# We leave you to decide, but if you put this into a folder that's been mapped

# into the container, then history will persist over container rebuilds :)

#

# !!!IMPORTANT!!!

# Make sure your .zsh_history file is NOT committed into your repository, as it can contain

# sensitive information. So in this case, you should add

# .devcontainer/.zsh_history

# to your .gitignore file.

#

ENV HISTFILE="$PWD/.devcontainer/.zsh_history"

# Install and cache poetry dependencies

# Why don't we do this for you in the gdal-python image???

# Well, it's because we can't conditionally mount a cache (for dev/slim images).

# Also, if you're not using poetry, it doesn't make sense for us to force a cache.

#

COPY pyproject.toml poetry.lock ./
RUN --mount=type=cache,id=dev-cache,target=/root/.cache \
 poetry config virtualenvs.create false && \
 poetry install $(test "$INSTALL_DEV_TOOLS" != true && echo "--no-dev") --no-interaction --no-ansi

# Setting this ensures print statements and log messages promptly appear

ENV PYTHONUNBUFFERED TRUE

// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
// https://github.com/microsoft/vscode-dev-containers/tree/v0.187.0/containers/python-3
{
  "name": "GeoPython",
  "build": {
    "dockerfile": "Dockerfile",
    "context": "..",
  },

  // Set *default* container specific settings.json values on container create.
  "settings": {
    "austin.mode": "Wall time",
    "editor.defaultFormatter": "esbenp.prettier-vscode",
    "editor.formatOnSave": true,
    "jupyter.widgetScriptSources": ["jsdelivr.com", "unpkg.com"],
    "prettier.prettierPath": "/usr/local/prettier", // Note: Prettier is installed (with its requisite installation of node to run it) already, and linked here
    "python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
    "python.formatting.blackPath": "/usr/local/py-utils/bin/black",
    "python.formatting.provider": "black",
    "python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
    "python.languageServer": "Pylance",
    "python.linting.banditPath": "/usr/local/py-utils/bin/bandit",
    "python.linting.enabled": true,
    "python.linting.flake8Path": "/usr/local/py-utils/bin/flake8",
    "python.linting.mypyPath": "/usr/local/py-utils/bin/mypy",
    "python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle",
    "python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
    // Line length to match black settings
    // Disabling specific messages:
    //  - To find the details do: /usr/local/py-utils/bin/pylint --list-msgs
    //  - Disable missing-module-docstring (C0114) because we don't document modules routinely, just their members
    //  - Disable invalid-name (C0103) because pylint thinks that eg 'x', 'df', 'np' are invalid due to their lengths
    "python.linting.pylintArgs": [
      "--max-line-length=120",
      "--disable=missing-module-docstring,invalid-name"
    ],
    "python.linting.pylintEnabled": true,
    "python.linting.pylintPath": "/usr/local/py-utils/bin/pylint",
    "python.pythonPath": "/usr/local/bin/python",
    "terminal.integrated.defaultProfile.linux": "zsh"
  },

  // Add the IDs of extensions you want installed when the container is created.
  "extensions": [
    "esbenp.prettier-vscode",
    "irongeek.vscode-env",
    "mikestead.dotenv",
    "ms-python.python",
    "ms-python.vscode-pylance",
    "ms-toolsai.jupyter",
    "ms-toolsai.jupyter-renderers",
    "ms-toolsai.jupyter-keymap",
    "ms-vsliveshare.vsliveshare",
    "p403n1x87.austin-vscode", // For profiling
    "ritwickdey.liveserver"  // For serving previews of html documents, e.g. those generated by sphinx
  ],

  // Use 'forwardPorts' to make a list of ports inside the container available locally.
  "forwardPorts": [80, 443, 7045, 7046, 7047, 7048, 7049, 8080],

  // Use 'postCreateCommand' to run commands after the container is created.
  "postCreateCommand": "echo \"Install your requirements here\"",

  // Comment out connect as root instead - but some of the devtools might stop working! More info: https://aka.ms/vscode-remote/containers/non-root.
  "remoteUser": "vscode",

  // Allow ptrace based debuggers (like austin) to work in the container
  // DO NOT add these run arguments to containers that are in any way exposed to external users or the internet
  "runArgs": ["--cap-add=SYS_PTRACE", "--security-opt", "seccomp=unconfined"]
}