[DE] Schnellstartanleitung

Registered by Jochen Schnelle

Deutsche Schnellstartanleitung für pygcstats

Blueprint information

Status:
Complete
Approver:
Jochen Schnelle
Priority:
High
Drafter:
Jochen Schnelle
Direction:
Approved
Assignee:
None
Definition:
Approved
Series goal:
None
Implementation:
Informational Informational
Milestone target:
None
Started by
Jochen Schnelle
Completed by
Jochen Schnelle

Related branches

Sprints

Whiteboard

pygcstats ist vollständig in Python programmiert, d.h. Python muss auf dem Rechner installiert sein. Aktuell benötigt pygcstats Python 2.7, Python 3.x wird noch nicht unterstützt. Python 2.6. funktioniert auch, wenn das argparse Modul zusätzlich installiert ist (es ist erst ab Python 2.7 standardmäßig enthalten).
Die aktuelle Python-Version kann auf http://www.python.org heruntergeladen werden. Linux-Nutzer können Python normalerweise über die Paketverwaltung installieren, sofern es nicht schon installiert ist.

pygcstats muss nicht installiert werden. Es muss lediglich die aktuelle Version heruntergeladen werden, welche als zip-Datei verfügbar ist. Diese zip-Datei kann in ein beliebiges Verzeichnis entpackt werden.
Weiterhin wird die eine GPX-Datei benötigt, welche alle gefundenen Caches enthält. Diese kann über die "Pocket Query" Funktion auf geocaching.com generiert werden, allerdings nur für Premium-Mitglieder.
Wenn der Pocket Query fertig generiert ist, kann die Datei heruntergeladen und entpackt werden. Grundsätzlich kann die Datei in einem beliebigen Verzeichnis liegen. Praktischer ist aber, wenn die GPX Datei im gleichen Verzeichnis wie pygcstats liegt. Die folgenden Schritte gehen davon aus, dass das der Fall ist.

pygcstats kann entweder über die Kommandozeile oder eine einfache, aber funktionelle, HTML-basiere Oberfläche, welche lokal im Browser läuft, genutzt werden. Die HTML-Oberfläche bietet ab Version 0.4 zusätzlich die Möglichkeit, innerhalb der gefundenen Caches zu suchen. Weitere Details zur HTML-Oberfläche sind weiter unten zu finden.

Um pygcstas via Kommandozeile zu nutzen öffnet man diese (Linux und MacOS Nutzer öffnen dazu einfach wie gewohnt einen Terminal; Windows Nutzer: drücke die Windows-Taste + R, dann "cmd" eingeben und Return drücken). Danach ins Verzeichnis wechseln, in welches pygcstats entpackt wurde.

Um die Geocaching Statistiken zu generieren, dient der folgende Befehl:

$ python pygcstats -i 8765432.gpx --lang=de

wobei natürliche der korrekte Name der eigenen GPX Datei angegeben werden muss, nicht der obige Beispielname. Dann wird die Statistik auf dem Bildschirm ausgegeben.

Der führende Aufruf von `python` ist zwingend nötig. Der Auftruf des Programms über z.B. `./pygcstats.py - 8765432.gpx` funktioniert nicht!

Möchte man die Statistik auf Englisch generieren, dann ist einfach die Option "--lang=de" wegzulassen.
Wird die Option - i nicht angegeben, dann sucht pygcstats im aktuellen Verzeichnis (also dem Verzeichnis, aus dem pygcstats aufgerufen wurde) nach einer GPX Datei. Wird dort keine GPX Datei gefunden oder gibt es mehr als eine wird eine Fehlermeldung ausgegeben.

Wenn eine HTML-Datei generiert werden soll, deren Inhalt dann mittels Copy&Paste auf die Profilseite bei geocaching.com übertragen werden soll, dann wird die --html Option benötigt:

$ python pygcstats.py -i 8765432.gpx --html --lang=de

Es wird eine Datei namens "geocaching_stats.html" im eigenen Home-Verzeichnis abgelegt.

pygcstats kennt eine Reihe weiterer Option, welche über

$ python pygcstats.py --help

angezeigt werden können.

Um die graphische, HTML-basierte Benutzeroberfläche zu nutzen wird diese mit dem folgenden Befehl aufgerufen:

$ python pygcstats_webUI.py

Der Browser sollte sich dann automatisch öffnen. Falls nicht, so ist der Webbrowser manuell zu starten und die Adresse:

http://localhost:8888/index.html

aufzurufen. Die Benutzeroberfläche im Browser ist nur auf Englisch verfügbar, kann aber deutschsprachige Statistiken generieren. Die Suche innerhalb der Caches ist ebenfalls komplett in Englisch.

Die vollständige Dokumentation (auf Englisch) ist hier zu finden: https://blueprints.launchpad.net/pygcstats/+spec/htmlui-userguide

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.

Subscribers

No subscribers.