OwlBoard/pyOwlBoard
1
0
Fork 0
Code Issues Pull Requests Actions Packages Activity
Python client for the OwlBoard API
22 Commits 1 Branch 1 Tag 75 KiB
Python 100%
main
Go to file
Fred Boniface 52c1125838 Update readme
2024-11-02 21:23:36 +00:00
.gitea/workflows Fix twine env variables 2024-10-31 21:05:23 +00:00
pyOwlBoard Bump versions 2024-10-31 17:08:40 +00:00
.gitignore Initial Commit 2024-10-28 21:37:33 +00:00
LICENSE Initial Commit 2024-10-28 21:37:33 +00:00
README.md Update readme 2024-11-02 21:23:36 +00:00
requirements.txt Initial Commit 2024-10-28 21:37:33 +00:00
setup.py Fix license string 2024-10-31 21:07:04 +00:00

README.md

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.