Skip to content

Add ScottishWater WaterCompany class#53

Draft
Copilot wants to merge 2 commits intomainfrom
copilot/add-scottish-water-class
Draft

Add ScottishWater WaterCompany class#53
Copilot wants to merge 2 commits intomainfrom
copilot/add-scottish-water-class

Conversation

Copy link
Copy Markdown

Copilot AI commented Mar 26, 2026

Scottish Water recently released a public near-real-time EDM API. This PR adds a ScottishWater subclass of WaterCompany to match the existing pattern for all other supported companies.

Key differences from existing companies

  • Different API format: Scottish Water's endpoint (GET /overflow-event-monitoring/v1/near-real-time) returns {"results": [...]} rather than the ArcGIS features[].attributes structure, so _fetch_current_status_df is overridden entirely.
  • OSGB coordinates provided directly: No lat/long conversion needed — the API supplies DISCHARGE_OVERFLOW_LOCATION_X/Y in OSGB36 already.
  • ISO 8601 UTC timestamps: A _parse_datetime helper strips tzinfo for consistency with how other companies handle naive datetimes.
  • 4-state status mapping:
    • 13Discharge (currently overflowing)
    • 14NoDischarge + discharge_in_last_48h=True (recent overflow)
    • 15NoDischarge (no overflow; checks OVERFLOW_END_DATETIME for 48h window)
    • 16Offline (no data)
  • No historical API: _fetch_monitor_history / set_all_histories are stubs, matching companies like AnglianWater and NorthumbrianWater.
  • D8 file pending: D8_FILE_URL and D8_FILE_HASH are set to "PLACEHOLDER" — update once the Scotland D8 file is uploaded to Zenodo. The corresponding test's check_watercompany() call is commented out until then.

Usage

from poopy.companies import ScottishWater

sw = ScottishWater()
print(sw.discharging_monitors)
print(sw.recently_discharging_monitors)

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • api.scottishwater.co.uk
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js (dns block)
  • zenodo.org
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js (dns block)
    • Triggering command: /usr/bin/curl curl -s REDACTED (dns block)
    • Triggering command: /usr/bin/curl curl -s --max-time 10 REDACTED (dns block)

If you need me to access, download, or install something from one of these locations, you can either:


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Agent-Logs-Url: https://github.com/AlexLipp/POOPy/sessions/13f67bda-0a40-4b99-b4a9-3418191f1aa8

Co-authored-by: AlexLipp <10188895+AlexLipp@users.noreply.github.com>
Copilot AI changed the title [WIP] Add ScottishWater class for event duration monitoring Add ScottishWater WaterCompany class Mar 26, 2026
Copilot AI requested a review from AlexLipp March 26, 2026 21:25
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.

2 participants