Quickstart guide for pygcstats

As pygcstats is completely written in Python, so you need to have Python installed on your computer. Currently, pygcstats does require Python 2.7,plus there is a port to Python 3 as well.
To get the most recent version of Python (either 2 or 3), please visit http://www.python.org. Linux users can most probably install Python via the package manager, if not installed already.

pygcstats does not require a installation in a common sense. The only thing you have to do is to download the latest, stable version, which is typically provided as a zip file. Unpack this to any directory of our choice.
Furthermore, you need the GPX file containing your finds. This can be generated on the "Pocket Query" page at geocaching.com. Please note that pocket queries can, unfortunately, be generated by Premium Members only.
Once the "My Finds" pocket query is ready, download it and unpack. Although the GPX file can be anywhere on your computer, it may be most convenient to place it in the same directory to which you unpacked pygcstats. The following steps assume this is the case.

pygcstats can be run via a the terminal or via the HTML-based user interface which runs locally in the browers. Custom searching through your found caches can only be done via the HTML user interface. Details how to use that can be found below.

To use pygcstats via a terminal, go the the command line (Linux and MacOS users: open a terminal; Windows users: press the Windows-key + R, type "cmd" and press Enter) and switch to the directory where pygcstats is located.

To generate your geocaching statistics, simple type the following command:

$ python pygcstats -i 8765432.gpx

whereas you need of course enter the actual name of your GPX file, not the example name above. This will output the statistics to your screen.

Please note that the pygcstats explicitly needs to be called with python. Starting the program eg './pygcstats.py -i 8765432.gpx' won't work!

In case the -i option is omitted, pygcstats will search automatically for a single GPX file in the directory from where pygcstats is called. In case no or more than one GPX file is found, and error message will be displayed.

In case you want to generate a HTML file to copy & paste into your geocaching.com profile page, use the --html switch:

$ python pygcstats.py -i 8765432.gpx --html

and a file named "geocaching_stats.html" will be placed in your Home-Directory.

pygcstats knows several more options. To display them, just type

$ python pygcstats.py --help

In case you prefer a graphical user interface, pygcstats provides a HTML-based user interface as well. Run the file:

$ python pygcstats_html_uiI.py

and your browser should open automatically. If not, open your web browser manually and enter the URL http://localhost:8888/index.html

In case you are running the Python 3 version of pygcstats, simply replace the program names with the ones of the Python 3 port, which are:

pygcstats3.py - for the command-line version
pygcstats3_html_ui.py - for the HTML-based user-interface

All features and functions of the Python 3 port are 100% identical to the one of the Python 2.7 version.

The full documentation as a PDF file can be found in the download section: https://launchpad.net/pygcstats/+download

Or read the full docs online at: https://pygcstats.readthedocs.org/en/latest/