Usage

Data

The data is provided in JSON. Its format and description is outlined at Data Format.

Raw

Use a HTTP GET request to https://raw.githubusercontent.com/MRT-Map/gatelogue/dist/data.json to retrieve the data.

A version without sources is available, at https://raw.githubusercontent.com/MRT-Map/gatelogue/dist/data_no_sources.json

gatelogue-types (Python)

The data can be imported to your Python project in msgspec dataclasses. Run pip install gatelogue-types or add gatelogue-types to your requirements.txt or pyproject.toml.

(To import directly from the repository, run pip install git+https://github.com/mrt-map/gatelogue#subdirectory=gatelogue-types-py or add gatelogue-types @ git+https://github.com/mrt-map/gatelogue#subdirectory=gatelogue-types-py to your requirements.txt or pyproject.toml.)

You can also use requests, niquests, httpx, urllib3 or aiohttp to retrieve the data via gatelogue-types if [requests], [niquests], [httpx], [urllib3] or [aiohttp] is suffixed. Otherwise urllib is used.

To retrieve the data:

import gatelogue_types as gt  # alias highly recommended for convenience's sake

gt.GatelogueData.get()  # retrieve data, with sources

gt.GatelogueDataNS.get()  # retrieve data, no sources

await gt.GatelogueData.aiohttp_get()  # retrieve data, with sources, async

await gt.GatelogueDataNS.aiohttp_get()  # retrieve data, no sources, async

See the API reference for gatelogue_types.

gatelogue-types (Rust)

See the docs for gatelogue-types (Rust).

gatelogue-types (TypeScript)

See the docs for gatelogue-types (TypeScript).

Aggregator

The aggregator can be installed wih pipx (regular pip is fine too): pipx install git+https://github.com/mrt-map/gatelogue#subdirectory=gatelogue-aggregator.

See Command Line.