Skip to main content

moveq-catalogue

Same / replace / omit registry for cross-country transport-equity questionnaires.

PyPI Python versions License

When a method built for one country (a coverage question, a deprivation proxy, a night-service indicator) is reused in another, three things happen in practice:

  1. some items transfer — the question is the same; only the local dataset changes (GTFS here, a national timetable there)
  2. some items do not transfer — the UK IMD is not the French grille de densité; you need a named local substitute
  3. some items cannot be measured at small-area resolution in the destination country, and should be dropped on the record

Without an explicit contract, the usual failure is silent omission: a base section is forgotten, inherited, or deleted in a spreadsheet, and the two countries are compared as if they answered the same questionnaire.

moveq-catalogue makes that contract programmatic. You list the base sections once. For a target country you must register each section as SAME, REPLACE, or OMIT. validate() returns leftover section ids; an empty list means every base item has been decided. There is no default. Forgetting is an error, not a zero.

This package has no numeric dependency (no NumPy). Most applications should install moveq, which re-exports Catalogue and SectionAction.

The three actions

Action Meaning What you must supply
SAME The question / method carries over against local data Optional note (local source, geography)
REPLACE A locally meaningful question takes its place Required replacement_title; optional note
OMIT No acceptable small-area variable exists Required note explaining the drop

REPLACE without a title, or OMIT without a note, raises. Registering an unknown section id also raises. Duplicate ids in the base list are rejected at construction.

summary() counts how many sections landed in each bucket, which is useful in a methods appendix (“12 same, 3 replaced, 1 omitted”).

The full taxonomy and a worked multi-country example: catalogue guide.

Installation

Requires Python 3.10+.

pip install moveq-catalogue

Usage

from moveq_catalogue import Catalogue, SectionAction

base_sections = ["coverage_pct", "service_deserts", "policy_scenarios"]

ie = Catalogue(base_sections, country="ireland")
ie.register("coverage_pct", SectionAction.SAME, note="TFI × CSO Small Area")
ie.register("service_deserts", SectionAction.SAME)
ie.register(
    "policy_scenarios",
    SectionAction.REPLACE,
    replacement_title="Connecting Ireland / Local Link / BusConnects",
)

issues = ie.validate()
if issues:
    raise SystemExit(issues)  # e.g. a base section with no decision
print(ie.summary())  # {'same': 2, 'replace': 1, 'omit': 0}

Documentation

License

BSD 3-Clause.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

moveq_catalogue-0.1.1.tar.gz (6.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

moveq_catalogue-0.1.1-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

Details for the file moveq_catalogue-0.1.1.tar.gz.

File metadata

  • Download URL: moveq_catalogue-0.1.1.tar.gz
  • Upload date:
  • Size: 6.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for moveq_catalogue-0.1.1.tar.gz
Algorithm Hash digest
SHA256 a040a0a46e72be774f8a1428eacb24550863cb4135ffee6fcf89cd635cd84ae6
MD5 cb930d0be6aebd53c29f51a40095701e
BLAKE2b-256 dd95cf6a2da5d28def086c7567e8f64f0c9b3ea932cb0272c82e0add9d8a88ec

See more details on using hashes here.

Provenance

The following attestation bundles were made for moveq_catalogue-0.1.1.tar.gz:

Publisher: publish.yml on SVamseekar/moveq

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file moveq_catalogue-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for moveq_catalogue-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1caf4b1bd1f533c284243b1450022cfd5bc4b28e195f56222ada4e77dda8b2ce
MD5 25b369849070d1b0123bec7ac08b3107
BLAKE2b-256 de064bc4040ec0797dbac5839e15ddcf5bdf282403f3863449ff3a4a223806dd

See more details on using hashes here.

Provenance

The following attestation bundles were made for moveq_catalogue-0.1.1-py3-none-any.whl:

Publisher: publish.yml on SVamseekar/moveq

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.1.2

2 files

This release

0.1.1 This release

2 files

0.1.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page