How to use the HTML-based User Interface

Registered by Jochen Schnelle

A comprehensive guide how to use the HTML-base user interface to pygcstats

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

For everybody who feels not comfortable (or familiar) running an application with a command-line interface only, pygcstats provides a very simple, yet functional, HTML-base user-interface, which runs completely in the local browser.
Although you interact with your web browser, pygcstats does _not_ transfer any data, nor does it require a network connection. It runs completely local.

To start the user-interface in your browser, simply go to the directory to which you unpacked pygcstats and run the program

$ python pygcstats_html_ui.py

Please note that the pygcstats_html_ui explicitly needs to be called with python, Starting the program eg './pygcstats_html_ui.py' won't work!

After a second or so, your standard browser should open automatically, displaying pygcstats HTML-based user-interface. In case your browser does not open, start it manually and enter the URL `http://localhost:8888/index.html`.

In case you want to custom search through your found caches instead of generating a statistic, please read https://blueprints.launchpad.net/pygcstats/+spec/htmlui-search .

Now you see a flatly-styled page, which looks like any web page (as said, the program runs local only, not network access needed and done!).
You can select the GPX-file to generate the statistics from, check (or uncheck) the boxes for verbose output (=more details), add FTFs to the output (since version 0.3), skip calculating any percentage data for the output and choose if custom text / HTML before and after the statistics should be added. The checkboxes are similar to the options --verbose, --ftf, --no-percentage and --beforeafterhtml on the command-line (see https://blueprints.launchpad.net/pygcstats/+spec/command-line-options for details). Furthermore, the language for the statistics can be chosen, as well as the style of the HTML output to be generated.
Clicking on the button "Generate statistics" will do so and a few moments later the statistics will appear in your browser window. The output is - of course - identical to the one generated with the command-line program pygcstats, as in the background the same programs and libraries are used to process the data.

When you scroll to the very bottom of the statistics, you will see a link text labelled "Show Source". Clicking this will show the HTML source code of the statistics, which can be than copied & pasted into your profile page at geocaching.com.
Please note that your browser needs to have Javascript enabled (which is default to all browser today), otherwise displaying the HTML source code won't work.

Once you read through your statistics and / or did all copy & paste work, you can close the tab in your browser displaying the statistics. After that, please also stop the local webserver displaying the page, by going back to the command-line you started pygcstats_html_ui.py from and press there CTRL+C.

For more (technical) details on how the local server and pygcstats_html_ui.py works, please read https://blueprints.launchpad.net/pygcstats/+spec/htmlui-tech

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.

Subscribers

No subscribers.