OCDL: Unterschied zwischen den Versionen
Zur Navigation springen
Zur Suche springen
K
→Verfügbare gespeicherte Suchen auslesen
(neu erstellt) |
Dl6hbo (Diskussion | Beiträge) |
||
(16 dazwischenliegende Versionen von 3 Benutzern werden nicht angezeigt) | |||
Zeile 1: | Zeile 1: | ||
{ | '''OCDL''' ('''O'''pen'''c'''aching '''D'''own'''l'''oader) ist ein [[wikipedia:Python_(Programmiersprache)|Python]]-Skript zum Download von [[Suchformular#Gespeicherte Suche|gespeicherten Suchen]] als [[GPX-Datei|GPX-Dateien]]. OCDL ist besonders dann nützlich, wenn man regelmäßig gespeicherte Suchen herunterladen möchte, beispielsweise um die Cache-Datenbank von [[OpenCacheManager]] auf einem aktuellen Stand zu halten. Das Skript ist dabei weniger für die manuelle und interaktive Verwendung gedacht, als für den automatisierten, zeitgesteuerten Aufruf, beispielsweise via [[wikipedia:Cron|Cron]]. | ||
== Systemvoraussetzungen == | |||
OCDL ist ein betriebssystemunabhängiges Skript und sollte auf allen Systemen lauffähig sein, auf denen eine aktuelle Python-Version installiert ist. Typische Unixe bringen Python bereits mit; unter Windows ist meist eine manuelle Installation von Python notwendig (z.B. [http://www.activestate.com/activepython ActivePython]). | |||
== Allgemein == | |||
OCDL ist ein Kommandozeilenprogramm und wird daher innerhalb der Kommandozeile (Linux/Unix: Terminalfenster, Windows: Eingabeaufforderung) verwendet. | |||
Wie für Kommandozeilenprogramme üblich, verfügt OCDL über eine integrierte Hilfsfunktion, die über den Parameter <tt>--help</tt> aufgerufen werden kann: | |||
<pre> | |||
user@host:~/GPX> ./ocdl.py --help | |||
Usage: ocdl.py [options] [ID...] | |||
Options: | |||
--version show program's version number and exit | |||
-h, --help show this help message and exit | |||
-s, --setup create the necessary directories; ask the user for | |||
login credentials | |||
-c CONFIGDIR, --configdir=CONFIGDIR | |||
specify directory for config files (cookies, login | |||
information); default is '~/.ocdl' | |||
-l, --list list available queries, do not download them | |||
-n STYLE, --name=STYLE | |||
select naming style of downloaded queries, STYLE={ ID, | |||
ID+DATE, NAME, NAME+DATE }, default is 'ID' | |||
-d TARETDIR, --dir=TARETDIR | |||
select target directory for downloaded queries; | |||
default is the current directory | |||
-v, --verbose print verbose status messages | |||
ocdl.py logs in to opencaching.de using login credentials which are stored | | |||
| in '~/.ocdl/config.txt' (the actual directory is configurable using the | | |||
| '--configdir' command line option). | | |||
| | | |||
| You can use the command line option '--setup' to create the configuration | | |||
| directory and to initialize the config file with your login credentials. | | |||
| | | |||
| Alternatively, you can manually create the configuration directory and | | |||
| the config file: | | |||
| Make sure the directory '~/.ocdl/' (or whatever you chose by | | |||
| '--configdir') exists and contains the file 'config.txt' with the | | |||
| following two lines: | | |||
| | | |||
| OCDE_LOGIN='username' | | |||
| OCDE_PASSWORD='password' | | |||
| | | |||
| where username and password are your login credentials for opencaching.de | | |||
| | | |||
| | | |||
| Moreover, ocdl.py stores the login cookie 'cookies.txt' in the selected | | |||
| config directory for future logins. | | |||
</pre> | |||
== Konfiguration == | |||
OCDL hat eine Setup-Funktion, die die notwendigen Verzeichnisse anlegt und den Nutzer nach seinen Zugangsdaten für Opencaching.de fragt. Dazu ruft man OCDL mit dem Parameter <tt>--setup</tt> auf und gibt seine Zugangsdaten ein: | |||
<pre> | |||
user@host:~/GPX> ./ocdl.py --setup | |||
Performing setup. | |||
Enter your username for OC.de: XXX | |||
Enter your password for OC.de: YYY | |||
Setup done. You may re-run 'ocdl.py' in normal mode. | |||
</pre> | |||
Danach ist OCDL fertig konfiguriert und kann normal verwendet werden. Falls sich die Zugangsdaten ändern sollten, kann die Setup-Funktion jederzeit wieder aufgerufen werden. | |||
== Verfügbare gespeicherte Suchen auslesen == | |||
Mit dem Kommandozeilenparameter <tt>--list</tt> wird die Liste der im [[Benutzerprofil|Opencaching-Benutzerprofil]] gespeicherten Suchen abgefragt und ausgegeben: | |||
<pre> | |||
user@host:~/GPX> ./ocdl.py --list | |||
11339629/'Tradis in Berlin' | |||
42325999/'OC-only Deutschland' | |||
</pre> | |||
In obigem Beispiel sind zwei Suchen verfügbar, nämlich „Tradis Berlin“ mit der ID 11339629 und „OC-only Deutschland“ mit der ID 42325999. Die ID-Nummern werden für den Download der Suchen benötigt. | |||
== Download der Suchen == | |||
Hat man festgestellt, welche Suchen überhaupt verfügbar sind, kann man diese auch herunterladen. Dazu übergibt man die entsprechende ID als Parameter an OCDL. | |||
Mit folgendem Aufruf läd man die Suche „OC-only Deutschland“ als ZIP-komprimierte GPX-Datei herunter: | |||
<pre> | |||
user@host:~/GPX> ./ocdl.py 42325999 | |||
</pre> | |||
Die heruntergeladene Datei wird dann '''42325999.zip''' genannt und im aktuellen Verzeichnis abgelegt bzw. in dem Verzeichnis, dass über den Parameter <tt>--dir</tt> festgelegt wurde. | |||
Die Benennung der Dateien kann über den Parameter <tt>--name</tt> beeinflusst werden: | |||
* <tt>--name ID</tt> erzeugt Dateien nach dem Schema '''ID.zip''', im Beispiel: '''42325999.zip''' | |||
* <tt>--name ID+DATE</tt> erzeugt Dateien nach dem Schema '''ID_Datum.zip''', hängt also das aktuelle Datum an die ID an; im Beispiel: '''42325999_2012-10-26.zip''' | |||
* <tt>--name NAME</tt> erzeugt Dateien nach dem Schema '''Name.zip''', wobei '''Name''' der Name der gespeicherten Suche ist; Leerzeichen im Name werden dabei durch Unterstriche ersetzt; im Beispiel: '''OC-only_Deutschland.zip''' | |||
* <tt>--name NAME+DATE</tt> erzeugt Dateien nach dem Schema '''Name_Datum.zip'''; im Beispiel: '''OC-only_Deutschland_2012-10-26.zip''' | |||
== Weblinks == | |||
* [https://raw.github.com/flopp/ocdl.py/master/ocdl.py Direkt-Download von OCDL] | |||
* [https://github.com/flopp/ocdl.py OCDL bei github.com] | |||
* [http://www.python.org/ Python] | |||
[[Kategorie:Geocaching-Software]] | |||
[[Kategorie:Opencaching]] |