Eclectic Media Git pingstats / cd0bf41
Updates sphinx-docs for V1.0, multi-backend support - Also updates Version tag to 1.0.0 Ariana Giroux a month ago
5 changed file(s) with 18 addition(s) and 12 deletion(s). Raw diff Collapse all Expand all
4848 #. V0.9.2
4949 #. V0.9.3
5050 #. V0.9.4
51 #. V1.0.0
5152
5253 ====
5354
99 Forking the project
1010 -------------------
1111
12 To fork the project, first clone it from `the official repositry`_:
12 To fork the project, first clone it from `the official repository`_:
1313 ::
1414
1515 git clone git://git.eclecticmedia.space/public/pingstats.git
44 Software Description
55 ====================
66
7 This script provides a simple CLI based ping visualization script by utilizing `hipster plot`_ with customize-able UI views.
7 This script provides a very simple CLI based ping visualization script by utilizing either `hipsterplot`_ or `gnuplot`_/`asciiplotlib`_.
88
9 The software aims to remain lightweight and as os-independent as possible while maintaining ex sensibility throughout the software.
9 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.
1010
1111 ----------------------
1212 Why should you use it?
2828 Installation
2929 ============
3030
31 Installation has been made easy on any system that implements ``pip3``.
32 ::
31 To install the base package (and use the simple backend, `hipsterplot`_), installation has been made easy via ``pip``. ::
3332
3433 pip3 install pingstats
34
35 If however, you are using Linux and can install the `gnuplot`_ library, first obtain the binary from ``apt``: ::
36
37 sudo apt-get install gnuplot
38
39 .. note:: The pingstats package will automatically use gnuplot if it is available.
3540
3641 ----
3742
4348 repository and moving into the subsequent directory:
4449 ::
4550
46 git clone https://gitlab.com/EclectickMediaSolutions/pingstats.git && cd pingstats
51 git clone https://git.eclecticmedia.space/public/pingstats.git && cd pingstats
4752
4853
4954 .. note:: To checkout the newest, experimental changes ensure you are on the
50 ``rolling-release`` branch with ``git checkout rolling-release``
55 ``master`` branch
5156
5257 Once the repository is cloned, you can run the ``setup.py`` script to install
5358 the local files:
107112 To run the tests, clone the repository:
108113 ::
109114
110 git clone https://gitlab.com/eclectickmediasolutions/pingstats.git
115 git clone https://git.eclecticmedia.space/public/pingstats.git
111116
112117 Then simply run:
113118 ::
118123 .. include:: CONTRIBUTION.rst
119124
120125
121 .. _`hipster plot`: https://github.com/imh/hipsterplot
126 .. _`hipsterplot`: https://github.com/imh/hipsterplot
127 .. _`gnuplot`: http://www.gnuplot.info/
128 .. _`asciiplotlib`: https://pypi.org/project/asciiplotlib/
122129 .. _PingStats: https://github.com/eclectickmedia/pingstats
2323 .. autoclass:: pingstats.ui.Widget
2424 :members: __init__
2525 .. autoclass:: pingstats.ui.PingWidget
26 :members: __init__
27 .. autoclass:: pingstats.ui.PlotWidget
2826 :members: __init__
2927
3028 --------------
3939 exit(1)
4040
4141
42 __version__ = "0.9.4"
42 __version__ = "1.0.0"
4343 PROG_NAME = 'pingstats'
4444
4545 # PARSER CONFIG