pyOwlBoard/README.md
2024-11-02 21:23:36 +00:00

787 B

pyOwlBoard

The Python client for the OwlBoard API

This client was written as part of 'dgp2'. As it stands, only the features required for dgp2 and few others are implemented.

Endpoints

The following API features are available:

  • get_stops_by_pis
  • get_pis_by_start_end_crs
  • get_trains_by_headcode
  • get_trains_by_trainUid
  • get_loc_ref_codes_by_tiploc

No other features are currently exposed. In the meantime, consider OwlBoardTS which is a fully featured API Client for use with TypeScript.

Installing

The package can be installed with pip:

From my Gitea server: pip install --index-url https://git.fjla.uk/api/packages/OwlBoard/pypi/simple/ pyOwlBoard

From PyPI: pip install pyOwlBoard

The packages are kept in sync between the two package repositories.