Re: [PATCH 2/2] gnu: Add nyx.

[ng0 <contact.ng0@cryptolab.net>]

Tobias Geerinckx-Rice <me@tobias.gr> writes:

> * gnu/packages/tor.scm (nyx): New variable.
> ---
>
> Guix,
>
> This adds Nyx (no relation), a handy status monitor for Tor relays.

Cool!
So it seems you have evaded the problems with the custom setup
phase they have, which I ran into. Strange. But nice.

> A 2.0 release has been just around the corner for... more than half a
> year now, but the last 1.x version is from 2012. It also had an entirely
> different name (‘Arm’) and I'd rather not deal with the confusion.
>
> This one has been nothing but stable for me, so I'd thought I'd share it.
>
> If we instead decide to wait another year for a ‘real’ release, so be it.

I think it's okay, take a look at this search and the reactions I
got about it.
https://lists.gnu.org/archive/cgi-bin/namazu.cgi?query=nyx&submit=Search&idxname=guix-devel
For the git commit you could mention that this used to be called
"arm" and since then has been replaced by "nyx", see the comment
Ludovic gave.

> Kind regards,
>
> T G-R
>
> gnu/packages/tor.scm | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 61 insertions(+)
>
> diff --git a/gnu/packages/tor.scm b/gnu/packages/tor.scm
> index 97e7ec9..b3b8238 100644
> --- a/gnu/packages/tor.scm
> +++ b/gnu/packages/tor.scm
> @@ -3,6 +3,7 @@
>  ;;; Copyright © 2014, 2015 Mark H Weaver <mhw@netris.org>
>  ;;; Copyright © 2016 Efraim Flashner <efraim@flashner.co.il>
>  ;;; Copyright © 2016, 2017 ng0 <contact.ng0@cryptolab.net>
> +;;; Copyright © 2017 Tobias Geerinckx-Rice <me@tobias.gr>
>  ;;;
>  ;;; This file is part of GNU Guix.
>  ;;;
> @@ -223,3 +224,63 @@ internet.  The other user just needs to use Tor Browser to download the file
>  from you.")
>      (license (list license:gpl3+
>                     license:bsd-3))))    ; onionshare/socks.py
> +
> +(define-public nyx
> +  (let ((commit "fea209127484d9b304b908a4711c9528b1d065bc")
> +        (revision "1"))                 ; Guix package revision
> +    (package
> +      (name "nyx")
> +      (version (string-append "1.9-" revision "."
> +                              (string-take commit 7)))
> +      (source
> +       (origin
> +         (method git-fetch)
> +         (file-name (string-append name "-" version "-checkout"))
> +         (uri (git-reference
> +               (url "https://git.torproject.org/nyx.git")
> +               (commit commit)))
> +         (sha256
> +          (base32
> +           "1g0l4988076xg5gs0x0nxzlg58rfx5g5agmklvyh4yp03vxncdb9"))))
> +      (build-system python-build-system)
> +      (native-inputs
> +       ;; For tests.

I think this comment is not needed.

> +       `(("python-mock" ,python-mock)
> +         ("python-pep8" ,python-pep8)
> +         ("python-pyflakes" ,python-pyflakes)))
> +      (inputs
> +       `(("python-stem" ,python-stem)))
> +      (arguments
> +       `(#:configure-flags
> +         (list (string-append "--man-page="
> +                              (assoc-ref %outputs "out")
> +                              "/share/man/man1/nyx.1")
> +               (string-append "--sample-path="
> +                              (assoc-ref %outputs "out")
> +                              "/share/doc/nyx/nyxrc.sample"))
> +         #:use-setuptools? #f           ; setup.py still uses distutils

Sidecomment: Ah! That's the obvious error I failed to spot when I gave it a try.

> +         #:phases
> +         (modify-phases %standard-phases
> +           (replace 'check
> +                    (lambda _

I think the indendation is wrong here.

> +                      (zero? (system* "./run_tests.py" "--unit")))))))
> +      ;; There's no home page yet.  This should change before the 2.0 release.
> +      (home-page "https://gitweb.torproject.org/nyx.git")
> +      (synopsis "Tor relay status monitor")
> +      (description "Nyx monitors the performance of relays participating in the
> +@uref{https://www.torproject.org/, Tor anonymity network}.  It displays this
> +information visually and in real time, using a curses-based terminal interface.
> +This makes Nyx well-suited for remote shell connections and servers without a
> +graphical display.  It's like @command{top} for Tor, providing detailed
> +statistics and status reports on:
> +
> +@enumerate
> +@item connections (with IP address, hostname, fingerprint, and consensus data),
> +@item bandwidth, processor, and memory usage,
> +@item the relay's current configuration,
> +@item logged events,
> +@item and much more.
> +@end enumerate
> +
> +Potential client and exit connections are scrubbed of sensitive information.")
> +      (license license:gpl3))))
> -- 
> 2.9.3
>
>


-- 
ng0 -- https://www.inventati.org/patternsinthechaos/