From 9c9489aee1051e5c45782bd03741230793d2785d Mon Sep 17 00:00:00 2001 From: profitroll Date: Fri, 7 Oct 2022 15:22:52 +0200 Subject: [PATCH] Started writing wiki --- wiki/Client.md | 30 ++++++++++++++++++++++++++++++ wiki/Home.md | 5 +++++ wiki/_Sidebar.md | 15 +++++++++++++++ 3 files changed, 50 insertions(+) create mode 100644 wiki/Client.md create mode 100644 wiki/Home.md create mode 100644 wiki/_Sidebar.md diff --git a/wiki/Client.md b/wiki/Client.md new file mode 100644 index 0000000..5f875c0 --- /dev/null +++ b/wiki/Client.md @@ -0,0 +1,30 @@ +# 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. + +This page is about the Client class, which exposes high-level methods for an easy access to the API. + +```py +from pyrmv import Client + +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` + +### 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: +* [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]` +* [journey_detail](https://git.end-play.xyz/profitroll/PythonRMV/wiki/journey_detail) -> `Journey` +* [stop_by_coords](https://git.end-play.xyz/profitroll/PythonRMV/wiki/stop_by_coords) -> `List[Stop]` +* [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 diff --git a/wiki/Home.md b/wiki/Home.md new file mode 100644 index 0000000..498c410 --- /dev/null +++ b/wiki/Home.md @@ -0,0 +1,5 @@ +# PythonRMV + +Welcome to the project's Wiki. + +Conceptional there are two different types of methods. Normal and raw ones. Raw methods are only beautiful variant of HTTP requests, nothing except for that actually. Normal ones are meant to be used as objects. You can still provide strings here and there, but basic concept is focused on objects usage. \ No newline at end of file diff --git a/wiki/_Sidebar.md b/wiki/_Sidebar.md new file mode 100644 index 0000000..a7b5992 --- /dev/null +++ b/wiki/_Sidebar.md @@ -0,0 +1,15 @@ +## [Home](https://git.end-play.xyz/profitroll/PythonRMV/wiki) + +### Classes +* [Client](https://git.end-play.xyz/profitroll/PythonRMV/wiki/Client) + +### Methods +* [board_arrival](https://git.end-play.xyz/profitroll/PythonRMV/wiki/board_arrival) +* [board_departure](https://git.end-play.xyz/profitroll/PythonRMV/wiki/board_departure) +* [him_search](https://git.end-play.xyz/profitroll/PythonRMV/wiki/him_search) +* [journey_detail](https://git.end-play.xyz/profitroll/PythonRMV/wiki/journey_detail) +* [stop_by_coords](https://git.end-play.xyz/profitroll/PythonRMV/wiki/stop_by_coords) +* [stop_by_id](https://git.end-play.xyz/profitroll/PythonRMV/wiki/stop_by_id) +* [stop_by_name](https://git.end-play.xyz/profitroll/PythonRMV/wiki/stop_by_name) +* [trip_find](https://git.end-play.xyz/profitroll/PythonRMV/wiki/trip_find) +* [trip_recon](https://git.end-play.xyz/profitroll/PythonRMV/wiki/trip_recon) \ No newline at end of file