Command-line options for pygcstats

Registered by Jochen Schnelle

The available command-line options for pygcstats are described here.

Blueprint information

Status:
Complete
Approver:
Jochen Schnelle
Priority:
Medium
Drafter:
Jochen Schnelle
Direction:
Approved
Assignee:
None
Definition:
Obsolete
Series goal:
None
Implementation:
Unknown
Milestone target:
None
Completed by
Jochen Schnelle

Related branches

Sprints

Whiteboard

A list of all available command-line options for pygcstats:

-i FILENAME.gpx: -i stand for "input file". The option has to be followed by the name of .gpx to generate the statistics from. The file name consists typically of 7 digits, input file has to be a valid .gpx file. Zipped files are not supported as input. In case the -i option is omitted, pygcstats searchs for a gpx file in current directory (=the directory from which pygcstats is called, _not_ the directory where pygcstats is located!).

-- lang=XX, -l=XX: choose the language of the output. Currently, only English (en) and German (de) are supported. Defaults to English is omitted.

--verbose, -v: more verbose output, which means simple more statistics on various things.

--no-percentage: do not calculate any percentages on the statistics, just display the counts.

--awards: add information on awards to output. Currently, only MD-points are calculated (details on MD-point: http://www.macdefender.org/products/GCStatistic/mdCachingPoints.html)

--html: redirect output to a HTML file instead of the screen. HTML file is placed in the Home directory. Note that --html does generate a HTML snippet only, which may be copied and pasted into your profile page at geocaching.com.

--fullhtml: same as --html, but generate a full HTML 5 file, including doctype definition, head-tag, body-tag etc. Use this option over --html in case you require a stand-alone HTML5 page.

--htmlfile FILENAME: specify the file name under which a generated HTML-file should be saved. If omitted, it defaults to "gecaching_stats.html"

--beforeafterhtml, -ba: add HTML from the files /formatters/template_general/before_statistics.html and /formatters/template_general/after_statistics.html before / after the actual statistics. This option can only be used along with the options --html or --fullhtml.

--ftf (available since version 0.3): include a list of your FTFs to the statistics. The cache IDs of the FTF caches are read from the file "formatters/templates/general/ftf.txt".

--style=STYLENAME: specify the CSS-style to be used when generating a HTML-file. Defaults to "gc", a style inspired by the geocaching.com homepage.
Alternative styles are: "md","gplus","basic" (a plain b/w style), "nostyle"

-ppl, --profilepagelong: a convenience shortcut for the options --html --verbose; not that using this option superseeds --fullhtml

-pps, --profilepageshort: a convenience shortcut for the options --html --verbose --no-percentage; not that using this option superseeds --fullhtml

-ppe, --profilepageextended: a convenience shortcut for the options --html --verbose --beforeafterhtml ; not that using this option superseeds --fullhtml

--to-csv (available since version 0.3): export all found caches into a CSV-file, which is saved in your home directory under the filename "my_found_caches.csv". In case --to-csv is used, all other options besides -i will be ignored. For further info please read: https://blueprints.launchpad.net/pygcstats/+spec/export-csv

--dump-db (available since version 0.4): export all found into SQLite3 database file, which is saved in your home directory under the filename "my_found_caches.db".
This file can be read directly via SQLite3 or any view / browser capable of reading SQLite3 file.

--help, -h: Display a help message, showing all available options on the command-line.

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.

Subscribers

No subscribers.