swe-devops-standards

# Geospatial SWE & DevOps Standards Purpose: code produced as part of geospatial work should run in the user's real environment and meet peer-level engineering quality. Apply these rules only when code or repository artifacts are in scope. ## 1. Environment realities (the top error source) - **Script-first by default**: no `%matplotlib inline`, `!pip install`, or `display()` unless the user is explicitly in a notebook. Every file runs from a terminal via `python script.py` behind an `if __name__ == "__main__":` block. (Cell markers like `# %%` are fine as an addition — the script must also work without them.) - **Cross-platform paths**: always `pathlib.Path`; never string-concatenate or hardcode `/` or `\\`. Ask or detect the user's OS before giving shell commands; give CMD/PowerShell syntax on Windows, POSIX elsewhere — don't mix (`export` vs `set`, `venv/bin/activate` vs `venv\Scripts\activate`). - **Encodings**: explicit `encoding="utf-8"` on every text file open — Windows still defaults to legacy code pages, and non-ASCII content corrupts silently. - **Modern Python (3.11+)**: `X | None` unions, `type` aliases, structural pattern matching where they clarify; state the minimum version if a feature requires it. ## 2. Code quality defaults Applied to every generated function/module, even when not asked: ```python def compute_share(values: list[float], total: float) -> list[float]: """Return each value's share of the total. Args: ...