Ein Semesterprojekt der Projektgruppe A3-3 im Modul "Programmierung für KI" an der Fachhochschule Südwestfalen
- Funktionen
- Installation
- Benutzung
- Vorgehensweise im Projekt
- Datenimport
- Ausblick
- Hinweise
- Anerkennung
- Tankstellen in der Umgebung suchen inkl. Echtzeitpreise
- Sortierung nach Preis und Entfernung
- Filtern nach Kraftstoffart
- Darstellung der Tankstellen mit Logo auf einer Karte
- Anzeige von historischen Preisen
- Empfehlung ob aktuell ein guter Zeitpunkt zum Tanken ist
Es gibt 2 Möglichkeiten die App zu installieren:
a) Die App kann als Zip-Datei auf Github unter "Releases" für die jeweilige Plattform heruntergeladen werden. Das heruntergeladene Archiv muss entpackt werden. Anschließend kann die Datei main mit Doppelklick ausgeführt werden.
Hinweis für MacOS-Nutzer: Sollte es beim Öffnen der ausführbaren Datei Probleme bzgl. eines nicht verifizierten Entwicklers geben, bitte einmal hier schauen: https://support.apple.com/de-de/guide/mac-help/mh40616/mac
b) Die App kann auch über den Quellcode installiert werden. Dazu muss das Repository geklont werden. Danach sollte in einer Virtuellen Umgebung die Datei requirements.txt installiert werden.
Abschließend kann die Datei main.py ausgeführt werden.
Wichtig: Bei Variante b) muss die unter Datenimport beschriebene Datenbank noch aktualisiert werden.
- Eingabe der Adresse in der Suchleiste und anschließendes Drücken der Enter-Taste oder des Suchbuttons
- Auswahl der gewünschten Kraftstoffart
- Auswahl der gewünschten Sortierung
- Tankstellen werden auf der Karte angezeigt
- Bei Auswahl einer Tankstelle in der Liste zoomt die Karte auf die entsprechende Tankstelle
- Es werde die Preise der letzten 7 Tage, der Durchnittspreis in diesem Zeitraum und eine Empfehlung zum Tanken angezeigt
Bildschirmfoto von unserem Trelloboard
In unserem ersten Treffen haben wir die Grundlage für unser App-Projekt gelegt. Unser Fokus lag darauf, die Funktionen der App zu definieren und einen Plan für deren Umsetzung zu entwickeln. Dabei haben wir uns für die Programmierung mit Python und Tkinter entschieden, da diese Tools eine effiziente und flexible Entwicklung ermöglichen.
Für die Datenintegration haben wir uns für die API von Tankerkönig entschieden. Dies war eine strategische Entscheidung, da Tankerkönig eine kostenlose API anbietet, die Echtzeitdaten liefert. Dies passt perfekt zu unseren Anforderungen und gewährleistet eine hohe Aktualität und Zuverlässigkeit der Daten in unserer App.
Um die Entwicklung dynamisch und anpassungsfähig zu gestalten, haben wir uns für einen agilen Ansatz entschieden. Wir arbeiteten in zweiwöchigen Sprints, was uns ermöglichte, regelmäßig Features zu implementieren und zu bewerten. Nach jedem Sprint reflektierten wir unsere Fortschritte und planten, welche neuen Features im nächsten Sprint integriert werden sollten. Diese Methode förderte nicht nur eine kontinuierliche Verbesserung, sondern auch eine flexible Anpassung an sich ändernde Anforderungen.
Für die Übersicht und Projektplanung setzten wir auf Trello. Dieses Tool half uns, Aufgaben zu organisieren, den Fortschritt zu verfolgen und effektiv als Team zusammenzuarbeiten. Zur Versionsverwaltung unserer Codebasis wählten wir GitHub. Dies ermöglichte uns eine sichere Speicherung unseres Codes, eine reibungslose Zusammenarbeit im Team und eine effiziente Verfolgung von Änderungen.
Insgesamt bildeten diese Entscheidungen und Tools die Grundlage für eine strukturierte und effiziente Entwicklung unserer App. Wir waren in der Lage, ein robustes Produkt zu schaffen, das auf den Prinzipien guter Softwareentwicklungspraktiken basiert.
Aktuell wird für den Abruf der historischen Spritpreise und der Berechnung von Durchschnittspreis und Preisempfehlung eine lokale SQLite-Datenbank verwendet. Die Datenbank wird in der Datei tk_hist.db im Ordner resources gespeichert. Es sind zum Abgabezeitpunkt die Daten vom 23.01.2024 bis zum 30.01.2024 enthalten.
Um die Daten zu aktualisieren, müssen die aktuellen CSV-Dateien von der Tankerkönig-Seite: https://dev.azure.com/tankerkoenig/_git/tankerkoenig-data?path=/prices geladen werden und in den Ordner data/csv kopiert werden. Anschließend kann das Skript import_hist_tk_data.py ausgeführt werden. Die Datenbank wird dann aktualisiert.
Aufgrund der Limitierung von Github von Dateigrößen auf 50 MB konnten wir die Datenbank nicht in das Repository hochladen. Deswegen muss die Datenbank lokal erstellt werden.
In zukünftigen Updates planen wir, die aktuelle SQLite-Datenbank durch eine remote gehostete Datenbank zu ersetzen. Dies wird es uns ermöglichen, die Daten zentral zu speichern und von verschiedenen Geräten aus darauf zuzugreifen. Die Kommunikation mit der Datenbank wird über eine REST-Schnittstelle erfolgen, die eine standardisierte und effiziente Interaktion mit den Daten ermöglicht. Dieser Schritt wird die Skalierbarkeit und Flexibilität unserer Anwendung erheblich verbessern.
Desweiteren planen wir, Caching-Techniken einzuführen, um die Leistung und Benutzererfahrung zu verbessern. Caching ermöglicht es uns, häufig abgerufene Daten temporär zu speichern, um zukünftige Anfragen schneller zu bedienen.
Ein weiterer wichtiger Aspekt, den wir in zukünftigen Updates verbessern möchten, ist die Reaktionszeit der Benutzeroberfläche. Aktuell können bei schnellem Klicken oder Wechseln von Elementen Ladezeiten entstehen. Um dies zu optimieren, planen wir, Nebenläufigkeit und asynchrone Programmierung zu implementieren.
Mit der asynchronen Programmierung können wir mehrere Aufgaben gleichzeitig ausführen, ohne dass die Benutzeroberfläche blockiert wird. Dies ermöglicht es der Anwendung, auf Benutzereingaben zu reagieren, während sie gleichzeitig andere Aufgaben im Hintergrund ausführt. Dies wird die Benutzererfahrung erheblich verbessern, indem es die wahrgenommenen Ladezeiten reduziert und die allgemeine Reaktionsfähigkeit der Anwendung erhöht.
-
Im Repository wurden Dateien mit dem Zusatz "_old" im Dateinamen gekennzeichnet. Diese Dateien sind nicht mehr aktuell und wurden durch neuere Versionen ersetzt. Sie wurden jedoch nicht gelöscht, um den Entwicklungs-Prozess nachvollziehbarer zu machen.
-
Für die Erstellung dieser Readme und der Dokumentation inklusive der Inline-Kommentare sowie der Unit-Tests wurde die Hilfe von Github Copilot & OpenAI ChatGPT in Anspruch genommen. Desweiteren wurden diese Tools auch zum Auflösen und Beheben von Fehlermeldungen verwendet.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent