commit f4c077343706a4661f7a9f06e6f96159f0125a3e Author: Antonia PĂ©rez-Cerezo Date: Wed Feb 7 22:34:11 2024 +0100 Initial commit, add crude first draft diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e4e5f6c --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +*~ \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..e4f5a9a --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +# Travelynx integration for waybar + +This script adds a very simple [travelynx](https://travelynx.de) +integration into [waybar](https://github.com/Alexays/Waybar), showing +DS100 (or if it doesn't exist, the name) of the station the user is +checked into as well as the currently estimated arrival time. + +## Usage + +- Request a travelynx status API token + +Add the following lines to your waybar config, replacing the path to +the script and the travelynx token with the appropriate values, and +registering the plugin at the desired position in the bar. + + + "custom/travelynx": { + "format": "{}", + "exec": "/path/to/script.py [travelynx_token]", + "interval": 20, + "return-type": "json", + "on-click": "x-www-browser https://travelynx.de", + }, + + +Optionally, a css class can be set for the script: + +``` +#custom-travelynx { + background-color: #000000; + padding: 0 5px; +} +``` + +Note that this module is still very much WIP and new features may be +added at any time. + + +## Credits + +Copyright (c) 2024 Antonia + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/travelynx-waybar.py b/travelynx-waybar.py new file mode 100755 index 0000000..2697465 --- /dev/null +++ b/travelynx-waybar.py @@ -0,0 +1,53 @@ +#!/usr/bin/python3 + + +# Copyright (c) 2024 Antonia + +# Permission is hereby granted, free of charge, to any person obtaining +# a copy of this software and associated documentation files (the +# "Software"), to deal in the Software without restriction, including +# without limitation the rights to use, copy, modify, merge, publish, +# distribute, sublicense, and/or sell copies of the Software, and to +# permit persons to whom the Software is furnished to do so, subject to +# the following conditions: + +# The above copyright notice and this permission notice shall be +# included in all copies or substantial portions of the Software. + +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + +import sys +import json +import urllib.request +import time + +token = sys.argv[1] + +contents = urllib.request.urlopen("https://travelynx.de/api/v1/status/"+token).read() + +response = json.loads(contents) +#print(response) + +s = "" + +if response["checkedIn"] : + if "toStation" in response : + s = response["toStation"] + if "ds100" in s and s["ds100"] : + name = s["ds100"] + else : + name = s["name"] + arrtime = time.strftime("%H:%m", time.localtime(int(s["realTime"]))) + delay = (int(s["realTime"]) - int(s["scheduledTime"])) // 60 + s = f'{name} {arrtime}' + if delay > 0 : + s = s + " (+%d)" % delay + +print(json.dumps({"text": s, "tooltip": "", "class": "active", "percentage": ""}))