diff mbox series

[bug#40757] New package: VisiData

Message ID RoiyMULUjGVOW3uPsdNHBfZqzTyiHm9dNBj8afqAl9_u2qg5u3biqdqlHbKYgjIq33NPdMcFO1jxE-5DK0dJjLet2xcW_DAjuKnV9zFc7lI=@protonmail.com
State Accepted
Headers show
Series [bug#40757] New package: VisiData | expand

Checks

Context Check Description
cbaines/comparison success View comparision
cbaines/git branch success View Git branch
cbaines/applying patch fail View Laminar job

Commit Message

guix--- via Guix-patches via April 22, 2020, 12:51 a.m. UTC
Hi Guix! This patch adds a package for VisiData.

VisiData is an interactive multitool for tabular data. It combines the clarity of a spreadsheet, the efficiency of the terminal, and the power of Python, into a lightweight utility which can handle millions of rows with ease. https://www.visidata.org/, GPLv3

Tests are disabled because they are not packaged with the source tarball.
You can view test status here: https://circleci.com/gh/saulpw/visidata/tree/stable
Upstream suggests tests will be packaged with their source tarball around their 2.0 release.

Cheers,
Ryan Prior

Comments

Jack Hill April 22, 2020, 3:53 p.m. UTC | #1
Ryan,

On Wed, 22 Apr 2020, Ryan Prior via Guix-patches via wrote:

> Hi Guix! This patch adds a package for VisiData.
> 
> VisiData is an interactive multitool for tabular data. It combines the clarity of a
> spreadsheet, the efficiency of the terminal, and the power of Python, into a
> lightweight utility which can handle millions of rows with ease.
> https://www.visidata.org/, GPLv3

Thanks for the patch! This looks like some cool software.

I'm not an expert reviewer, but I'd like to try to help by offering the 
following suggestions for improvement.

>diff --git a/gnu/packages/visidata.scm b/gnu/packages/visidata.scm
>new file mode 100644
>index 0000000000..d9df94dc9b
>--- /dev/null
>+++ b/gnu/packages/visidata.scm

When adding new modules, please also add the file to gnu/local.mk

>+(define-module (visidata)

The module name should be (gnu packages visidata) to match the filesystem 
path.

It might be helpful to catch problems like this to try to apply your patch 
apply your patch to a guix source checkout, and try building your package 
from there. The manual has some documentation about that, 
<https://guix.gnu.org/manual/en/html_node/Building-from-Git.html>, but I 
can answer questions as well.

>+(define-public visidata
>+  (package
>+   (name "visidata")
>+   (version "1.5.2")
>+   (source (origin
>+            (method url-fetch)
>+            (uri (string-append "https://github.com/saulpw/visidata/archive/v" version ".tar.gz"))

The GitHub archive URIs are not stable and could result in a different 
hash in the future. Often in these cases we use git-fetch, but since 
visidata is available on pypi, I would recommend

(uri (pypi-uri "visidata" version))

>+            (sha256 (base32 "0h7hq6bnc8svkcc9995kkmgcb9n5qgm85rsshzzdicmg9rg3ymhi"))))
>+   (build-system python-build-system)
>+   (arguments '(#:tests? #f))
>+   ;; Tests disabled because they are not packaged with the source tarball.
>+   ;; View test status here: https://circleci.com/gh/saulpw/visidata/tree/stable
>+   ;; Upstream suggests tests will be packaged with tarball around 2.0 release.

Nitpick: I would prefer to have the comment before the code. I think the 
line about circleci could be removed, but the other two seem good.

>+   (native-inputs
>+    `(("python-dateutil" ,python-dateutil)
>+      ("python-fonttools" ,python-fonttools)
>+      ("python-h5py" ,python-h5py)
>+      ("python-lxml" ,python-lxml)
>+      ("python-openpyxl" ,python-openpyxl)
>+      ("python-psycopg2" ,python-psycopg2)
>+      ("python-pyyaml" ,python-pyyaml)
>+      ("python-requests" ,python-requests)
>+      ("python-xlrd" ,python-xlrd)
>+      ("python-pandas" ,python-pandas)))

Are these all native inputs (required to make the build system run)? I 
expect that some of them could be moved to inputs (run-tine dependencies).

>+   (synopsis "Visidata: A terminal spreadsheet multitool for discovering and arranging data")

guix lint reports that the synopsis should not start with the package 
name. In this case, I think it could be changed to, "Terminal spreadsheet 
for discovering and arranging data".

>+   (description
>+    "VisiData is an interactive multitool for tabular data. It combines the

Please use two spaces between sentences in the description.

>+clarity of a spreadsheet, the efficiency of the terminal, and the power of
>+Python, into a lightweight utility which can handle millions of rows with ease.")

Nitpick: "with ease" sounds like a marketing term, and I believe we can 
leave it out here.

>+   (home-page "https://www.visidata.org/")
>+   (license gpl3)))

In other modules, we import licenses with the license: prefix, so we can 
refer to licenses as like license:gpl3. It might be nice to do that 
here for consistency as well.

The vdtui.py file is under the expat license, so we should record that 
here. With these changes the license field would become something like:

(license (list license:gpl3
                license:expat)) ; visidata/vdtui.py

Thanks and all the best,
Jack
Ricardo Wurmus April 23, 2020, 5:24 a.m. UTC | #2
Hi Ryan,

I’ve adjusted the patch to gnu/local.mk which no longer applied, changed
spaces to tabs in gnu/local.mk, fixed the indentation of visidata.scm,
ran “guix lint”, built it and tested it (didn’t know how to exit, so I
just did ^Zkill %1) … and pushed it to the master branch with commit
c47f48d972.

Thank you for your patch!

--
Ricardo
Ricardo Wurmus April 23, 2020, 5:25 a.m. UTC | #3
Hey Jack,

thanks to your review and Ryan’s response to it I only had to perform
minimal changes to apply the patch.  Thank you very much!

--
Ricardo
Jack Hill April 23, 2020, 3:29 p.m. UTC | #4
On Thu, 23 Apr 2020, Ricardo Wurmus wrote:

>
> Hey Jack,
>
> thanks to your review and Ryan’s response to it I only had to perform
> minimal changes to apply the patch.  Thank you very much!

You're welcome. It makes me happy to help where I can.

I 💚 Guix
diff mbox series

Patch

From a86e002cd133371eafbd1adbf1354afd3796c9eb Mon Sep 17 00:00:00 2001
From: Ryan Prior <rprior@protonmail.com>
Date: Tue, 21 Apr 2020 16:56:42 -0500
Subject: [PATCH] gnu: Add visidata.

* gnu/packages/visidata.scm (visidata): New variable.
---
 gnu/packages/visidata.scm | 61 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 61 insertions(+)
 create mode 100644 gnu/packages/visidata.scm

diff --git a/gnu/packages/visidata.scm b/gnu/packages/visidata.scm
new file mode 100644
index 0000000000..d9df94dc9b
--- /dev/null
+++ b/gnu/packages/visidata.scm
@@ -0,0 +1,61 @@ 
+;;; GNU Guix --- Functional package management for GNU
+;;; Copyright © 2020 Ryan Prior <rprior@protonmail.com>
+;;;
+;;; This file is part of GNU Guix.
+;;;
+;;; GNU Guix is free software; you can redistribute it and/or modify it
+;;; under the terms of the GNU General Public License as published by
+;;; the Free Software Foundation; either version 3 of the License, or (at
+;;; your option) any later version.
+;;;
+;;; GNU Guix is distributed in the hope that it will be useful, but
+;;; WITHOUT ANY WARRANTY; without even the implied warranty of
+;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;;; GNU General Public License for more details.
+;;;
+;;; You should have received a copy of the GNU General Public License
+;;; along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.
+
+(define-module (visidata)
+  #:use-module (gnu packages databases)
+  #:use-module (gnu packages python-science)
+  #:use-module (gnu packages python-web)
+  #:use-module (gnu packages python-xyz)
+  #:use-module (gnu packages time)
+  #:use-module (gnu packages xml)
+  #:use-module (guix build-system python)
+  #:use-module (guix download)
+  #:use-module (guix licenses)
+  #:use-module (guix packages))
+
+(define-public visidata
+  (package
+   (name "visidata")
+   (version "1.5.2")
+   (source (origin
+            (method url-fetch)
+            (uri (string-append "https://github.com/saulpw/visidata/archive/v" version ".tar.gz"))
+            (sha256 (base32 "0h7hq6bnc8svkcc9995kkmgcb9n5qgm85rsshzzdicmg9rg3ymhi"))))
+   (build-system python-build-system)
+   (arguments '(#:tests? #f))
+   ;; Tests disabled because they are not packaged with the source tarball.
+   ;; View test status here: https://circleci.com/gh/saulpw/visidata/tree/stable
+   ;; Upstream suggests tests will be packaged with tarball around 2.0 release.
+   (native-inputs
+    `(("python-dateutil" ,python-dateutil)
+      ("python-fonttools" ,python-fonttools)
+      ("python-h5py" ,python-h5py)
+      ("python-lxml" ,python-lxml)
+      ("python-openpyxl" ,python-openpyxl)
+      ("python-psycopg2" ,python-psycopg2)
+      ("python-pyyaml" ,python-pyyaml)
+      ("python-requests" ,python-requests)
+      ("python-xlrd" ,python-xlrd)
+      ("python-pandas" ,python-pandas)))
+   (synopsis "Visidata: A terminal spreadsheet multitool for discovering and arranging data")
+   (description
+    "VisiData is an interactive multitool for tabular data. It combines the
+clarity of a spreadsheet, the efficiency of the terminal, and the power of
+Python, into a lightweight utility which can handle millions of rows with ease.")
+   (home-page "https://www.visidata.org/")
+   (license gpl3)))
-- 
2.17.1