Eclectic Media Git pingstats / cbc3be0
Updates sphinx docs to reflect changes in V1.0.0 Ariana Giroux a month ago
3 changed file(s) with 20 addition(s) and 30 deletion(s). Raw diff Collapse all Expand all
1111
1212 To install the base package (and use the simple backend, `hipsterplot`_), installation has been made easy via ``pip``. ::
1313
14 pip3 install pingstats
14 pip3 install -e git://git.eclecticmedia.space/public/pingstats#egg=pingstats
1515
16 If however, you are using Linux and can install the `gnuplot`_ library, first obtain the binary from ``apt``: ::
16 If however, you are using Linux and can install the `gnuplot`_ library, obtain the binary from your package manager: ::
1717
1818 sudo apt-get install gnuplot
1919
4141 Building & Viewing the Docs
4242 ===========================
4343
44 Our documentation is online in full at `https://pingstats.readthedocs.io/`_.
44 Our documentation is online in full at `pingstats.readthedocs.io`_.
4545
4646 ----
4747
9090 .. _`hipsterplot`: https://github.com/imh/hipsterplot
9191 .. _`gnuplot`: http://www.gnuplot.info/
9292 .. _`asciiplotlib`: https://pypi.org/project/asciiplotlib/
93 .. _PingStats: https://git.eclecticmedia.space/public/pingstats
9493 .. _`git-native forking workflow`: https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow
9594 .. _`Google Group`: https://groups.google.com/forum/#!forum/pingstats
9695 .. _`on our site`: http://eclecticmedia.space:8012
9796 .. _`gotty`: https://github.com/yudai/gotty
98 .. _`https://pingstats.readthedocs.io`: https://pingstats.readthedocs.io
97 .. _`pingstats.readthedocs.io`: https://pingstats.readthedocs.io
99 Forking the project
1010 -------------------
1111
12 To fork the project, first clone it from `the official repository`_:
13 ::
12 The project uses a `git-native forking workflow`_. For example,
1413
15 git clone git://git.eclecticmedia.space/public/pingstats.git
14 Clone the repository, ::
1615
17 Then, create your own public repository and set the origin url to that repository:
18 ::
16 git clone https://gitlab.com/eclectickmediasolutions/pingstats.git
1917
20 git remote set-url origin *your repository*
18 Then, make your changes (in a branch), and push them to a new (public) remote: ::
2119
22 Once we have set your remote to origin, we can tell git where the upstream is:
23 ::
20 git remote set-url upstream $(git remote get-url origin) # save origin as upstream
21 git remote set-url origin git@your.new:path/to/repo
22 git push -u origin master
2423
25 git remote add upstream git://git.eclecticmedia.space/public/pingstats.git
24 Once your code is hosted publicly, notify the maintainers of your changes with a
25 ``git request-pull``... ::
2626
27 .. note:: The upstream should be the official repository.
28 .. note:: For more on the git native forking workflow, see the `git forking
29 tutorial`_
27 git request-pull upstream origin # upstream (this repo) should pull changes from new origin (new fork)
28
29 .. note:: You can address your email to pingstats@googlegroups.com
3030
3131 -----------------
3232 Our issue tracker
77 This script provides a very simple CLI based ping visualization script by utilizing either `hipsterplot`_ or `gnuplot`_/`asciiplotlib`_.
88
99 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.
10
11 We host a demo `on our site`_ via `gotty`_. This shows our server's average connection to ``google.ca`` with the `gnuplot`_ backend.
1012
1113 ----------------------
1214 Why should you use it?
3032
3133 To install the base package (and use the simple backend, `hipsterplot`_), installation has been made easy via ``pip``. ::
3234
33 pip3 install pingstats
35 pip3 install -e git://git.eclecticmedia.space/public/pingstats#egg=pingstats
3436
35 If however, you are using Linux and can install the `gnuplot`_ library, first obtain the binary from ``apt``: ::
37 If however, you are using Linux and can install the `gnuplot`_ library, obtain the binary from your package manager: ::
3638
3739 sudo apt-get install gnuplot
3840
9395 --list-widgets Output a list of available widgets for '-l'
9496 -V, --version show program's version number and exit
9597
96 ===========================
97 Examples of software in use
98 ===========================
99
100 .. image:: http://i64.tinypic.com/33mv6ud.png
101
102
103 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.
104
105 This display automatically scales to whatever window you have open, adding more lines and columns as necessary.
106
10798
10899 =================
109100 Running the tests