diff --git a/Client.md b/Client.md index 32d311d..9684217 100644 --- a/Client.md +++ b/Client.md @@ -1,5 +1,6 @@ -# PythonRMV Client -You are now viewing the main class of the module, its heart. The main Client class, all available normal methods can be found here. +# pyrmv.Client + +You are now viewing the main class of the module, all available higher-level methods can be found here. This page is about the Client class, which exposes high-level methods for an easy access to the API. @@ -11,14 +12,14 @@ client = Client("SampleAPIKey") print(client.stop_by_id("A=1@O=Offenbach (Main)-Zentrum Marktplatz\/Frankf. Straße@X=8764456@Y=50105181@U=80@L=3002510@")) ``` -# Details - -## `class pyrmv.Client` +## Details ### Parameters + * access_key (`str`) – Access ID for identifying the requesting client. Get your key on [RMV website](https://opendata.rmv.de/site/start.html). -### Methods: +### Methods + * [board_arrival](https://git.end-play.xyz/profitroll/PythonRMV/wiki/board_arrival) -> `BoardArrival` * [board_departure](https://git.end-play.xyz/profitroll/PythonRMV/wiki/board_departure) -> `BoardDeparture` * [him_search](https://git.end-play.xyz/profitroll/PythonRMV/wiki/him_search) -> `List[Message]` @@ -27,4 +28,4 @@ print(client.stop_by_id("A=1@O=Offenbach (Main)-Zentrum Marktplatz\/Frankf. Stra * [stop_by_id](https://git.end-play.xyz/profitroll/PythonRMV/wiki/stop_by_id) -> `Union[Stop, None]` * [stop_by_name](https://git.end-play.xyz/profitroll/PythonRMV/wiki/stop_by_name) -> `List[Stop]` * [trip_find](https://git.end-play.xyz/profitroll/PythonRMV/wiki/trip_find) -> `List[Trip]` -* [trip_recon](https://git.end-play.xyz/profitroll/PythonRMV/wiki/trip_recon) -> `List[Trip]` \ No newline at end of file +* [trip_recon](https://git.end-play.xyz/profitroll/PythonRMV/wiki/trip_recon) -> `List[Trip]`