Eclectic Media Git pingstats / V0.9b4
V0.9b4

Tree @V0.9b4 (Download .tar.gz)

Pingstats, a simple CLI based ping visualization script

This script provides a very simple CLI based ping visualization script by utilizing hipster plot.

This project is a much simplified version of PingStats, a project of mine that went from being useful (i.e, the functionality of this script) to an over complicated mess of spaghetti code. That software provides GUI based plotting, as well as CSV based logging of ping data over time.

Installation

System Message: INFO/1 (<string>, line 12)

Possible title underline, too short for the title. Treating it as ordinary text because it's so short.

Installation has been made easy on any Unix based system that implements pip3.

pip3 install pingstats

Note

For versions previous to V0.4.3, manual install must be used. All versions aside from V0.1 can be installed by cloning the repository and recreating the install script manually.

Usage

System Message: INFO/1 (<string>, line 22)

Possible title underline, too short for the title. Treating it as ordinary text because it's so short.

This software was implemented with simplicity in mind, and only provides one point of access:

pingstats google.ca

Examples of software in use

http://i64.tinypic.com/33mv6ud.png

In this image, we can see two separate outputs. The top display is a display of the most recent actual return times, whereas the bottom display is the average return time for each sequence.

This display automatically scales to whatever window you have open, adding more lines and columns as necessary.

Running the tests

System Message: INFO/1 (<string>, line 41)

Possible title underline, too short for the title. Treating it as ordinary text because it's so short.

To run the tests, clone the repository:

git clone https://gitlab.com/eclectickmediasolutions/pingstats.git

System Message: INFO/1 (<string>, line 46)

Possible title underline, too short for the title. Treating it as ordinary text because it's so short.

Then simply run:

python3 setup.py test

Building the Docs

System Message: INFO/1 (<string>, line 55)

Possible title underline, too short for the title. Treating it as ordinary text because it's so short.

To build the docs, first clone the repository:

git clone https://gitlab.com/eclectickmediasolutions/pingstats.git

System Message: INFO/1 (<string>, line 60)

Possible title underline, too short for the title. Treating it as ordinary text because it's so short.

Then simply run:

cd docs && make html

Note

The docs are built on top of sphinx, which can be installed via pip3 install sphinx

The documentation will be generated in the path docs/_build/html/. Open index.html to load the docs.

Contributing to the Project

This project enforces its own custom git hooks to ensure tests are run and kept up to date.

To ensure that these hook scripts are installed properly, please follow these instructions:

System Message: INFO/1 (<string>, line 81)

Possible title underline, too short for the title. Treating it as ordinary text because it's so short.

#. Ensure current working directory is git-hooks:

cd git-hooks

System Message: INFO/1 (<string>, line 86)

Possible title underline, too short for the title. Treating it as ordinary text because it's so short.

#. Run the hooks setup script

./setup.sh

Warning

These scripts are (as of V0.9) only compatible with POSIX standard bash. The scripts will run in Git Bash, so long as that environment has python3 & pip.

Note

These scripts also make use of an additional package (for internal developement) called git-tasks. Any use of these scripts is aware of its presence on the system. If git-tasks is not installed, all hook scripts ignore it.