streetworks

An open Python SDK for street works and roadworks data — the UK's registers, Europe's national feeds, the US WZDx standard, and providers across Australia and New Zealand, behind one consistent, typed, verification-first client.

We do this not because it is easy, but because it is hard.

Developed and published independently, in a personal capacity — not on behalf of, or endorsed by, any employer. See docs/governance/attribution.md for the full statement and contributor credits.

Why?

Roadworks data is published through wildly different systems — statutory registers, DATEX II, WZDx, ArcGIS, WFS, bespoke REST APIs and regional platforms. Almost every provider also has its own authentication, pagination, geometry, date formats and quirks.

streetworks solves that integration problem so you can get on with building applications instead of learning how every individual road authority happens to publish its data.

It provides one common model without pretending those sources are equivalent — preserving the differences, limitations and provenance that matter.

And, honestly, part of the fun is discovering how different organisations have chosen to put their data together.

Install

pip install streetworks            # core
pip install "streetworks[sns]"     # + SNS signature verification (cryptography)

Requires Python 3.10+. Early alpha, pre-1.0 — see docs/getting-started/installation.md for what's verified against live systems today.

Quickstart

from streetworks.streetmanager import StreetManagerClient, Environment

with StreetManagerClient("api-user@example.com", password, environment=Environment.SANDBOX) as sm:
    sm.authenticate()                                  # verify credentials
    submitted = sm.reporting.permits(status="submitted")

The fastest way to see everything working: copy the credential template, fill in what you have, and run the one-file tour — it logs in to each configured provider and retrieves a little real data (read-only). Providers you leave blank are skipped, and SRWR / OS Open USRN need no credentials at all.

cp .env.example .env      # then edit .env
python examples/quickstart.py

For connectivity checks without data retrieval: python scripts/smoke_test.py. Credential setup, environment variables and what to expect from a real run are in docs/getting-started/quickstart.md.

Coverage at a glance

UK statutory registers and gazetteers (Street Manager, DataVIA, D-TRO, SRWR, OS Open USRN), national and regional roadworks feeds and address/street registers across Europe, the US WZDx standard plus NYC/Chicago/Paris municipal permit registers, DriveBC (British Columbia, Canada), Australia (national + state), and New Zealand — and growing. Every provider carries an explicit network_scope and a confirmed (or honestly flagged unconfirmed) licence; nothing is silently assumed open.

streetworks.providers() / get_provider() let you find a provider by what it covers rather than needing to already know the module name — see docs/providers/index.md for the full coverage matrix, per-provider modules, and current Credentials-wanted scaffolds.

Examples

20 runnable examples in examples/ — single-provider reads, a Street Manager Open Data receiver, a Section 50 write-path connector (sandbox-verified, not production), a UK-first works_near join pattern over a documented four-provider subset (deliberately example code, not an SDK export — see docs/concepts/common-model.md), two cross-provider comparisons/maps, a real-time AV last-mile router that reroutes around live roadworks, and two visual showcases (a lone-worker crime-context map, an OS Open USRN terrain drape with a 3D-print export). Each one's docstring states exactly what it needs and what state it's really in — see docs/examples.md for the curated, one-line-per-example index.

Documentation

• Getting started — installation, quickstart, development
• Concepts — architecture, data model, data integrity discipline, CRS & datums, write path (Section 50)
• Providers — index / coverage matrix / credentials wanted, UK & Crown Dependencies, Europe, Italy, Switzerland, Austria, Portugal, United States, Canada, Australia, New Zealand, pending candidates
• Domain notes — provider quirks, UK permits, excluded territories
• Roadmap — docs/roadmap.md (chronological build log)
• Contributing — scaffold states, agent boundaries, and see CONTRIBUTING.md for the full ground rules
• Governance — licensing, attribution and capacity
• Full docs entry point: docs/index.md

Contributing

Contributions welcome — see CONTRIBUTING.md.

Licence

MIT. Not affiliated with or endorsed by the Department for Transport or Geoplace. Street Manager documentation is © Crown copyright, available under the Open Government Licence v3.0. See docs/governance/licensing.md for the full per-provider licence index.