cadmium-yellow

Crates.iocadmium-yellow
lib.rscadmium-yellow
version2024.3.2
sourcesrc
created_at2024-03-20 18:14:47.531233
updated_at2024-03-22 21:08:31.524799
descriptionA client library for the unofficial Nexus Tyne and Wear Metro real time information API
homepagehttps://github.com/DanNixon/cadmium-yellow
repositoryhttps://github.com/DanNixon/cadmium-yellow
max_upload_size
id1180840
size61,429
Dan Nixon (DanNixon)

documentation

README

cadmium-yellow

CI Crates.io Version docs.rs

A client library for the unofficial Nexus Tyne and Wear Metro real time information API.

Usage notes

Keep in mind that this API is for the Pop app and not a public API. When using it, poll the API in a manner that you would expect to come from the Pop app, i.e. quite sporadic, mostly no traffic apart from a few requests over a few minutes.

Things you could use this API for:

  • A better mobile app
  • A command line tool
  • Home automation integration, tied into e.g. a "leaving home" routine

Things you bloody well should not use this API for:

  • A departure board for your living room
  • A widget that tells you when to leave to catch the next Metro (regardless of if you actually have to leave or not)
  • Anything else that wastes requests collecting data that is of zero practical use to anyone
Commit count: 18

cargo fmt