Eclectic Media Git pingstats / V1.0.0-hotfix1
V1.0.0-hotfix1

Tree @V1.0.0-hotfix1 (Download .tar.gz)

Pingstats, a simple CLI based ping visualization script

This script provides a very simple CLI based ping visualization script by utilizing either hipsterplot or gnuplot/asciiplotlib.

The hipsterplot backend is a very simple and lightweight backend, meant to allow easier install and wider operating system reach. However, it is nowhere near as easy to read & understand as the gnuplot/asciiplotlib backend. It is highly recommended you make use of that backend if you can.

We host a demo on our site via gotty. This shows our server's average connection to google.ca with the gnuplot backend.

Installation

To install the base package (and use the simple backend, hipsterplot), installation has been made easy via pip.

pip3 install pingstats

If however, you are using Linux and can install the gnuplot library, first obtain the binary from apt:

sudo apt-get install gnuplot

Note

The pingstats package will automatically use gnuplot if it is available.

Usage

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

pingstats google.ca

Running the tests

To run the tests, clone the repository:

git clone https://git.eclecticmedia.space/public/pingstats.git

Then simply run:

python3 setup.py test

Building & Viewing the Docs

Our documentation is online in full at `https://pingstats.readthedocs.io/`_.


To build the docs, first clone the repository:

git clone https://git.eclecticmedia.space/public/pingstats.git

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

The project uses a git-native forking workflow. For example,

Clone the repository,

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

Then, make your changes (in a branch), and push them to a new (public) remote:

git remote set-url upstream $(git remote get-url origin)  # save origin as upstream
git remote set-url origin git@your.new:path/to/repo
git push -u origin master

Once your code is hosted publicly, notify the maintainers of your changes with a git request-pull...

git request-pull upstream origin  # upstream (this repo) should pull changes from new origin (new fork)

Note

You can address your email to pingstats@googlegroups.com

Our Issue Board

We use a Google Group hosted mailing list (pingstats@googlegroups.com) to track and recieve new patches and bug reports.

Docutils System Messages

System Message: ERROR/3 (<string>, line 45); backlink

Unknown target name: "https://pingstats.readthedocs.io/".

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

Hyperlink target "pingstats" is not referenced.

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

Hyperlink target "https://pingstats.readthedocs.io" is not referenced.