Metadata-Version: 2.4
Name: gatelogue-types
Version: 2.0.0b10
Summary: Types for loading and reading Gatelogue data
Project-URL: Documentation, https://mrt-map.github.io/gatelogue/docs
Project-URL: Issues, https://github.com/mrt-map/gatelogue/issues
Project-URL: Source, https://github.com/mrt-map/gatelogue
Project-URL: Changelog, https://github.com/MRT-Map/gatelogue/commits/main/
Project-URL: Homepage, https://mrt-map.github.io/gatelogue
Author: MRT Mapping Services
Author-email: 7d <61975820+iiiii7d@users.noreply.github.com>
License-Expression: GPL-3.0-only
Keywords: gatelogue,minecart rapid transit,mrt
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Games/Entertainment
Classifier: Typing :: Typed
Requires-Python: >=3.12
Requires-Dist: msgspec
Provides-Extra: aiohttp
Requires-Dist: aiohttp; extra == 'aiohttp'
Provides-Extra: all
Requires-Dist: aiohttp; extra == 'all'
Requires-Dist: httpx; extra == 'all'
Requires-Dist: niquests; extra == 'all'
Requires-Dist: requests; extra == 'all'
Requires-Dist: urllib3; extra == 'all'
Provides-Extra: httpx
Requires-Dist: httpx; extra == 'httpx'
Provides-Extra: niquests
Requires-Dist: niquests; extra == 'niquests'
Provides-Extra: requests
Requires-Dist: requests; extra == 'requests'
Provides-Extra: urllib3
Requires-Dist: urllib3; extra == 'urllib3'
Description-Content-Type: text/markdown

![](./gatelogue-client/public/gat2-light.png)

![Github Version](https://img.shields.io/github/v/release/MRT-Map/gatelogue)
![Docs Status](https://img.shields.io/github/actions/workflow/status/MRT-Map/gatelogue/.github%2Fworkflows%2Fpages.yml?style=flat&label=docs&link=https%3A%2F%2Fmrt-map.github.io%2Fgatelogue%2Fdocs)
![GitHub License](https://img.shields.io/github/license/MRT-Map/gatelogue)
![GitHub Pages Status](https://img.shields.io/github/actions/workflow/status/MRT-Map/gatelogue/.github%2Fworkflows%2Fpages.yml?style=flat&label=website&link=https%3A%2F%2Fmrt-map.github.io%2Fgatelogue)

![GitHub code size](https://img.shields.io/github/languages/code-size/MRT-Map/gatelogue)
![GitHub repo size](https://img.shields.io/github/repo-size/MRT-Map/gatelogue)
![GitHub last commit (branch)](https://img.shields.io/github/last-commit/mrt-map/gatelogue/main)
![GitHub commits since latest release (branch)](https://img.shields.io/github/commits-since/mrt-map/gatelogue/latest/main?include_prereleases)
![GitHub Release Date](https://img.shields.io/github/release-date/MRT-Map/gatelogue)

![GitHub last commit (branch)](https://img.shields.io/github/last-commit/mrt-map/gatelogue/dist?label=last%20data%20update)

Database of air, rail, sea, bus routes on the MRT

Client is hosted at https://mrt-map.github.io/gatelogue

Documentation for the aggregator and data format is located at https://mrt-map.github.io/gatelogue/docs

## development setup
if you want to use a github codespace, just open one! setup is handled for you, and will take a few minutes. (it's the green code button, under the codespaces tab)

if you'd rather do things locally, the easiest way to get started is with dev containers:

1. install docker
2. install the [remote development pack](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack) for vscode
3. Use Cmd/Ctrl + Shift + P -> 'Clone Repository in Container Volume' to clone this repo (don't use 'reopen in container', as that will conflict with pnpm)
4. the container will take a few minutes to install and set up

congrats! you did it!

run the aggregator with the command `gatelogue-aggregator run`

run the client with the command `cd gatelogue-client` and `pnpm run dev`
