[bug#57744] [PATCH 0/3] Add shirah and dependencies

[bug#57744] [PATCH 0/3] Add shirah and dependencies

[M]

shirah is a terminal-based ebook reader, which alone I'd see as a nice addition to Guix packages considering how light, flexible and customizable (themes, opacity, font options, keybindings) terminal emulators are, but it also comes with an optional RSVP mode for speed reading, which can be pretty convenient for a terminal reader since terminal windows can be resized to very small geometry without breaking. shirah also supports basic ebook-reading features, like resuming a read, or browsing from the TOC.

M (3):
  gnu: Add python-ebooklib.
  gnu: Add python-syllables.
  gnu: Add shirah.

 gnu/packages/ebook.scm      | 40 +++++++++++++++++++++++++++++++++++++
 gnu/packages/python-xyz.scm | 20 +++++++++++++++++++
 2 files changed, 60 insertions(+)

-- 
2.37.2

[bug#57744] [PATCH 1/3] gnu: Add python-ebooklib.

[M]

* gnu/packages/ebook.scm (python-ebooklib): New variable.
---
 gnu/packages/ebook.scm | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/gnu/packages/ebook.scm b/gnu/packages/ebook.scm
index c3a27cb113..be41318095 100644
--- a/gnu/packages/ebook.scm
+++ b/gnu/packages/ebook.scm
@@ -10,6 +10,7 @@
 ;;; Copyright © 2020 Zheng Junjie <873216071@qq.com>
 ;;; Copyright © 2021 la snesne <lasnesne@lagunposprasihopre.org>
 ;;; Copyright © 2021 Petr Hodina <phodina@protonmail.com>
+;;; Copyright © 2021 Mathieu Laparie <mlaparie@disr.it>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -678,3 +679,21 @@ (define-public libmobi
 @item handling encrypted documents
 @end itemize\n")
     (license license:lgpl3+)))
+
+(define-public python-ebooklib
+  (package
+    (name "python-ebooklib")
+    (version "0.17.1")
+    (source (origin
+              (method url-fetch)
+              (uri (pypi-uri "EbookLib" version))
+              (sha256
+               (base32
+                "1w972g0kmh9cdxf3kjr7v4k99wvv4lxv3rxkip39c08550nf48zy"))))
+    (build-system python-build-system)
+    (propagated-inputs (list python-lxml python-six))
+    (home-page "https://github.com/aerkalov/ebooklib")
+    (synopsis "Ebook library which can handle EPUB2/EPUB3 and Kindle format")
+    (description "Ebook library which can handle EPUB2/EPUB3 and Kindle
+format.")
+    (license license:agpl3)))
-- 
2.37.2

[bug#57744] [PATCH 2/3] gnu: Add python-syllables.

[M]

* gnu/packages/python-xyz.scm (python-syllables): New variable.
---
 gnu/packages/python-xyz.scm | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/gnu/packages/python-xyz.scm b/gnu/packages/python-xyz.scm
index 054bd3ed29..9d358a4926 100644
--- a/gnu/packages/python-xyz.scm
+++ b/gnu/packages/python-xyz.scm
@@ -128,6 +128,7 @@
 ;;; Copyright © 2022 Marek Felšöci <marek@felsoci.sk>
 ;;; Copyright © 2022 Hilton Chain <hako@ultrarare.space>
 ;;; Copyright © 2022 Tomasz Jeneralczyk <tj@schwi.pl>
+;;; Copyright © 2022 Mathieu Laparie <mlaparie@disr.it>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -10032,6 +10033,25 @@ (define-public python-yte
      "This package provides a YAML template engine with Python expressions.")
     (license license:expat)))
 
+(define-public python-syllables
+  (package
+    (name "python-syllables")
+    (version "1.0.3")
+    (source (origin
+              (method url-fetch)
+              (uri (pypi-uri "syllables" version))
+              (sha256
+               (base32
+                "0wkl6h0rg6fbsxfp0a8fnibf3l4l6lbh6z12cvcilgb6qhxzpmv3"))))
+    (build-system python-build-system)
+    (home-page "https://github.com/prosegrinder/python-syllables")
+    (synopsis
+     "A Python package for estimating the number of syllables in a word.")
+    (description
+     "This package provides a Python package for estimating the number of
+syllables in a word.")
+    (license license:gpl3+)))
+
 (define-public python-sympy
   (package
     (name "python-sympy")
-- 
2.37.2

[bug#57744] [PATCH 3/3] gnu: Add shirah.

[M]

* gnu/packages/ebook.scm (shirah): New variable.
---
 gnu/packages/ebook.scm | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/gnu/packages/ebook.scm b/gnu/packages/ebook.scm
index be41318095..a5a19cb9c0 100644
--- a/gnu/packages/ebook.scm
+++ b/gnu/packages/ebook.scm
@@ -697,3 +697,24 @@ (define-public python-ebooklib
     (description "Ebook library which can handle EPUB2/EPUB3 and Kindle
 format.")
     (license license:agpl3)))
+
+(define-public shirah
+  (package
+    (name "shirah")
+    (version "1.0.0")
+    (source (origin
+              (method url-fetch)
+              (uri (pypi-uri "shirah_reader" version))
+              (sha256
+               (base32
+                "0j15v435lz68c1mj5clfx5dmfyjc6jvvz2q8hqvv799mb2faj42y"))))
+    (build-system python-build-system)
+    (propagated-inputs (list python-beautifulsoup4 python-ebooklib
+                             python-syllables python-termcolor))
+    (home-page "https://github.com/hallicopter/shirah-reader")
+    (synopsis "A curses based terminal ebook reader with optional RSVP mode")
+    (description "@command{shirah} is a curses based terminal ebook reader that
+can display ebooks in the usual way or with Rapid Serial Visual Presentation, a
+method to enable speedreading by showing the text word by word at configurable
+speeds.")
+  (license license:expat)))
-- 
2.37.2

[bug#57744] [PATCH 0/3] Add shirah and dependencies

[Christopher Baines]

[-- Attachment #1: Type: text/plain, Size: 1071 bytes --]


M <matf@disr.it> writes:

> shirah is a terminal-based ebook reader, which alone I'd see as a nice
> addition to Guix packages considering how light, flexible and
> customizable (themes, opacity, font options, keybindings) terminal
> emulators are, but it also comes with an optional RSVP mode for speed
> reading, which can be pretty convenient for a terminal reader since
> terminal windows can be resized to very small geometry without
> breaking. shirah also supports basic ebook-reading features, like
> resuming a read, or browsing from the TOC.
>
> M (3):
>   gnu: Add python-ebooklib.
>   gnu: Add python-syllables.
>   gnu: Add shirah.
>
>  gnu/packages/ebook.scm      | 40 +++++++++++++++++++++++++++++++++++++
>  gnu/packages/python-xyz.scm | 20 +++++++++++++++++++
>  2 files changed, 60 insertions(+)


Hey,

These generally look good to me, but I think there are a few things to
fix before merging.

The license information looks off for all packages, can you take a look?

Also, the linter makes some comments about some package synopsis.

Thanks,

Chris

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 987 bytes --]

[bug#57744] [PATCH 0/3] Add shirah and dependencies

[Mathieu]

Thanks for the review! I fixed the synopsis and licenses for shirah and python-syllables, but python-ebooklib's agpl3 is correct, is it not?

On 2022-09-14 10:09 Christopher Baines <mail@cbaines.net> wrote:

>  
> M <matf@disr.it> writes:
>  
>> shirah is a terminal-based ebook reader, which alone I'd see as a
>> nice
>> addition to Guix packages considering how light, flexible and
>> customizable (themes, opacity, font options, keybindings) terminal
>> emulators are, but it also comes with an optional RSVP mode for
>> speed
>> reading, which can be pretty convenient for a terminal reader since
>> terminal windows can be resized to very small geometry without
>> breaking. shirah also supports basic ebook-reading features, like
>> resuming a read, or browsing from the TOC.
>>  
>> M (3):
>> gnu: Add python-ebooklib.
>> gnu: Add python-syllables.
>> gnu: Add shirah.
>>  
>> gnu/packages/ebook.scm      | 40
>> +++++++++++++++++++++++++++++++++++++
>> gnu/packages/python-xyz.scm | 20 +++++++++++++++++++
>> 2 files changed, 60 insertions(+)
>  
>  
> Hey,
>  
> These generally look good to me, but I think there are a few things
> to
> fix before merging.
>  
> The license information looks off for all packages, can you take a
> look?
>  
> Also, the linter makes some comments about some package synopsis.
>  
> Thanks,
>  
> Chris

[bug#57744] [PATCH 0/3] Add shirah and dependencies

[Maxime Devos]

[-- Attachment #1.1.1: Type: text/plain, Size: 331 bytes --]



On 15-09-2022 21:57, Mathieu wrote:
> Thanks for the review! I fixed the synopsis and licenses for shirah and python-syllables, but python-ebooklib's agpl3 is correct, is it not?

Looking at 
<https://github.com/aerkalov/ebooklib/blob/master/ebooklib/epub.py>, it 
appears to be agpl3+, not agpl3.

Greetings,
Maxime.

[-- Attachment #1.1.2: OpenPGP public key --]
[-- Type: application/pgp-keys, Size: 929 bytes --]

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 236 bytes --]

[bug#57744] [PATCH v2 1/3] gnu: Add shirah.

[M]

* gnu/packages/ebook.scm (shirah): New variable.
---
 gnu/packages/ebook.scm | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/gnu/packages/ebook.scm b/gnu/packages/ebook.scm
index be41318095..a5a19cb9c0 100644
--- a/gnu/packages/ebook.scm
+++ b/gnu/packages/ebook.scm
@@ -697,3 +697,24 @@ (define-public python-ebooklib
     (description "Ebook library which can handle EPUB2/EPUB3 and Kindle
 format.")
     (license license:agpl3)))
+
+(define-public shirah
+  (package
+    (name "shirah")
+    (version "1.0.0")
+    (source (origin
+              (method url-fetch)
+              (uri (pypi-uri "shirah_reader" version))
+              (sha256
+               (base32
+                "0j15v435lz68c1mj5clfx5dmfyjc6jvvz2q8hqvv799mb2faj42y"))))
+    (build-system python-build-system)
+    (propagated-inputs (list python-beautifulsoup4 python-ebooklib
+                             python-syllables python-termcolor))
+    (home-page "https://github.com/hallicopter/shirah-reader")
+    (synopsis "A curses based terminal ebook reader with optional RSVP mode")
+    (description "@command{shirah} is a curses based terminal ebook reader that
+can display ebooks in the usual way or with Rapid Serial Visual Presentation, a
+method to enable speedreading by showing the text word by word at configurable
+speeds.")
+  (license license:expat)))
-- 
2.37.2

[bug#57744] [PATCH v2 2/3] gnu: Add shirah.

[M]

* gnu/packages/ebook.scm (shirah): New variable.
---
 gnu/packages/ebook.scm | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/gnu/packages/ebook.scm b/gnu/packages/ebook.scm
index a5a19cb9c0..2ade4f4d7e 100644
--- a/gnu/packages/ebook.scm
+++ b/gnu/packages/ebook.scm
@@ -712,9 +712,9 @@ (define-public shirah
     (propagated-inputs (list python-beautifulsoup4 python-ebooklib
                              python-syllables python-termcolor))
     (home-page "https://github.com/hallicopter/shirah-reader")
-    (synopsis "A curses based terminal ebook reader with optional RSVP mode")
+    (synopsis "Terminal ebook reader with an optional RSVP mode")
     (description "@command{shirah} is a curses based terminal ebook reader that
 can display ebooks in the usual way or with Rapid Serial Visual Presentation, a
 method to enable speedreading by showing the text word by word at configurable
 speeds.")
-  (license license:expat)))
+  (license license:gpl2)))
-- 
2.37.2

[bug#57744] [PATCH v2 2/3] gnu: Add shirah.

[Maxime Devos]

[-- Attachment #1.1.1: Type: text/plain, Size: 199 bytes --]



On 15-09-2022 21:58, M wrote:
> +  (license license:gpl2)))

Going by 
<https://github.com/Hallicopter/shirah-reader/blob/main/shirah_reader/__main__.py>, 
it appears t be gpl2+, not gpl2.

[-- Attachment #1.1.2: OpenPGP public key --]
[-- Type: application/pgp-keys, Size: 929 bytes --]

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 236 bytes --]

[bug#57744] [PATCH v2 2/3] gnu: Add shirah.

[Mathieu]

Should I not use what they have in the LICENSE at the root of their repository instead?

I messed up my patchset v2, still learning the git send-email workflow, sorry for the clutter messages.

On 2022-09-15 22:01 Maxime Devos <maximedevos@telenet.be> wrote:

>  
>  
> On 15-09-2022 21:58, M wrote:
>> +  (license license:gpl2)))
>  
> Going by
> <https://github.com/Hallicopter/shirah-reader/blob/main/shirah_reader/
> __main__.py>, it appears t be gpl2+, not gpl2.

[bug#57744] [PATCH v2 2/3] gnu: Add shirah.

[Maxime Devos]

[-- Attachment #1.1.1: Type: text/plain, Size: 1939 bytes --]



On 15-09-2022 22:03, Mathieu wrote:
> Should I not use what they have in the LICENSE at the root of their repository instead?

shirah_reader does not have a LICENSE file, AFAICS.

Even if it did, usually the LICENSE file only contains the license text, 
and not extras like 'which version range'.

Even if there was a LICENSE file that states 'this version only', then 
there is still another file that states 'this version or later', then 
how would we know which one is correct?  Why would LICENSE have 
precedence?  Or why would the source file have precedence?

When such situations happen, we cannot resolve them, only the author can 
clarify matters.

Even if there is only a LICENSE file, then usually it does not specify 
‘this version only’ or ‘this version or later’.  In case of the GPL, we 
then have the following license condition:

‘14. Revised Versions of this License

Each version is given a distinguishing version number.  If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation.  _If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation._’

I don't consider adding a LICENSE file as ‘specifying a version number’, 
so I'd say that in such cases it's gpl1+ (as the license text needs to 
be distributed along the source code anyway (at least in v2 and v3)). 
(However, I suppose it could be argued that in such cases it's 
implicitly specified that it's ‘version-of-the-LICENSE-file-or-later’. 
Also not a lawyer.  And in such situations, maybe it would be best to 
just ask the author what they meant.)

Greetings,
Maxime.

[-- Attachment #1.1.2: OpenPGP public key --]
[-- Type: application/pgp-keys, Size: 929 bytes --]

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 236 bytes --]

[bug#57744] [PATCH v2 3/3] gnu: Add python-syllables.

[M]

* gnu/packages/python-xyz.scm (python-syllables): New variable.
---
 gnu/packages/python-xyz.scm | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/gnu/packages/python-xyz.scm b/gnu/packages/python-xyz.scm
index 9d358a4926..b64f2441bf 100644
--- a/gnu/packages/python-xyz.scm
+++ b/gnu/packages/python-xyz.scm
@@ -10050,7 +10050,7 @@ (define-public python-syllables
     (description
      "This package provides a Python package for estimating the number of
 syllables in a word.")
-    (license license:gpl3+)))
+    (license license:gpl3)))
 
 (define-public python-sympy
   (package
-- 
2.37.2

[bug#57744] [PATCH v3 1/3] gnu: Add python-ebooklib.

[M]

* gnu/packages/ebook.scm (python-ebooklib): New variable.
---
 gnu/packages/ebook.scm | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/gnu/packages/ebook.scm b/gnu/packages/ebook.scm
index c3a27cb113..8353012f11 100644
--- a/gnu/packages/ebook.scm
+++ b/gnu/packages/ebook.scm
@@ -10,6 +10,7 @@
 ;;; Copyright © 2020 Zheng Junjie <873216071@qq.com>
 ;;; Copyright © 2021 la snesne <lasnesne@lagunposprasihopre.org>
 ;;; Copyright © 2021 Petr Hodina <phodina@protonmail.com>
+;;; Copyright © 2021 Mathieu Laparie <mlaparie@disr.it>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -678,3 +679,21 @@ (define-public libmobi
 @item handling encrypted documents
 @end itemize\n")
     (license license:lgpl3+)))
+
+(define-public python-ebooklib
+  (package
+    (name "python-ebooklib")
+    (version "0.17.1")
+    (source (origin
+              (method url-fetch)
+              (uri (pypi-uri "EbookLib" version))
+              (sha256
+               (base32
+                "1w972g0kmh9cdxf3kjr7v4k99wvv4lxv3rxkip39c08550nf48zy"))))
+    (build-system python-build-system)
+    (propagated-inputs (list python-lxml python-six))
+    (home-page "https://github.com/aerkalov/ebooklib")
+    (synopsis "Ebook library which can handle EPUB2/EPUB3 and Kindle format")
+    (description "Ebook library which can handle EPUB2/EPUB3 and Kindle
+format.")
+    (license license:agpl3+)))
-- 
2.37.2

[bug#57744] [PATCH v3 2/3] gnu: Add python-syllables.

[M]

* gnu/packages/python-xyz.scm (python-syllables): New variable.
---
 gnu/packages/python-xyz.scm | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/gnu/packages/python-xyz.scm b/gnu/packages/python-xyz.scm
index 054bd3ed29..1b68209c67 100644
--- a/gnu/packages/python-xyz.scm
+++ b/gnu/packages/python-xyz.scm
@@ -128,6 +128,7 @@
 ;;; Copyright © 2022 Marek Felšöci <marek@felsoci.sk>
 ;;; Copyright © 2022 Hilton Chain <hako@ultrarare.space>
 ;;; Copyright © 2022 Tomasz Jeneralczyk <tj@schwi.pl>
+;;; Copyright © 2022 Mathieu Laparie <mlaparie@disr.it>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -10032,6 +10033,24 @@ (define-public python-yte
      "This package provides a YAML template engine with Python expressions.")
     (license license:expat)))
 
+(define-public python-syllables
+  (package
+    (name "python-syllables")
+    (version "1.0.3")
+    (source (origin
+              (method url-fetch)
+              (uri (pypi-uri "syllables" version))
+              (sha256
+               (base32
+                "0wkl6h0rg6fbsxfp0a8fnibf3l4l6lbh6z12cvcilgb6qhxzpmv3"))))
+    (build-system python-build-system)
+    (home-page "https://github.com/prosegrinder/python-syllables")
+    (synopsis "Package for estimating the number of syllables in a word")
+    (description
+     "This package provides a Python package for estimating the number of
+syllables in a word.")
+    (license license:gpl3)))
+
 (define-public python-sympy
   (package
     (name "python-sympy")
-- 
2.37.2

[bug#57744] [PATCH v3 3/3] gnu: Add shirah.

[M]

* gnu/packages/ebook.scm (shirah): New variable.
---
 gnu/packages/ebook.scm | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/gnu/packages/ebook.scm b/gnu/packages/ebook.scm
index 8353012f11..583b3da03b 100644
--- a/gnu/packages/ebook.scm
+++ b/gnu/packages/ebook.scm
@@ -697,3 +697,24 @@ (define-public python-ebooklib
     (description "Ebook library which can handle EPUB2/EPUB3 and Kindle
 format.")
     (license license:agpl3+)))
+
+(define-public shirah
+  (package
+    (name "shirah")
+    (version "1.0.0")
+    (source (origin
+              (method url-fetch)
+              (uri (pypi-uri "shirah_reader" version))
+              (sha256
+               (base32
+                "0j15v435lz68c1mj5clfx5dmfyjc6jvvz2q8hqvv799mb2faj42y"))))
+    (build-system python-build-system)
+    (propagated-inputs (list python-beautifulsoup4 python-ebooklib
+                             python-syllables python-termcolor))
+    (home-page "https://github.com/hallicopter/shirah-reader")
+    (synopsis "Terminal ebook reader with an optional RSVP mode")
+    (description "@command{shirah} is a curses based terminal ebook reader that
+can display ebooks in the usual way or with Rapid Serial Visual Presentation, a
+method to enable speedreading by showing the text word by word at configurable
+speeds.")
+  (license license:gpl2+)))
-- 
2.37.2

[bug#57744] [PATCH v3 3/3] gnu: Add shirah.

[Mathieu]

Thanks for clarifying! Shirah does not include a license file indeed, but the end of the README clarifies the intent of the author: they say we can use gpl2 or any later version at our convenience. "gpl2+" indeed looks more relevant then since it is listed in one of the source files, as you found.

Hopefully the patchset v3 is okay (I had to reset and restart from scratch, I could not figure out how to rebase v3 into three clean commits if starting from v2).

On 2022-09-15 22:38 M <matf@disr.it> wrote:

> * gnu/packages/ebook.scm (shirah): New variable.
> ---
> gnu/packages/ebook.scm | 21 +++++++++++++++++++++
> 1 file changed, 21 insertions(+)
>  
> diff --git a/gnu/packages/ebook.scm b/gnu/packages/ebook.scm
> index 8353012f11..583b3da03b 100644
> --- a/gnu/packages/ebook.scm
> +++ b/gnu/packages/ebook.scm
> @@ -697,3 +697,24 @@ (define-public python-ebooklib
> (description "Ebook library which can handle EPUB2/EPUB3 and Kindle
> format.")
> (license license:agpl3+)))
> +
> +(define-public shirah
> +  (package
> +    (name "shirah")
> +    (version "1.0.0")
> +    (source (origin
> +              (method url-fetch)
> +              (uri (pypi-uri "shirah_reader" version))
> +              (sha256
> +               (base32
> +                
> "0j15v435lz68c1mj5clfx5dmfyjc6jvvz2q8hqvv799mb2faj42y"))))
> +    (build-system python-build-system)
> +    (propagated-inputs (list python-beautifulsoup4 python-ebooklib
> +                             python-syllables python-termcolor))
> +    (home-page "https://github.com/hallicopter/shirah-reader")
> +    (synopsis "Terminal ebook reader with an optional RSVP mode")
> +    (description "@command{shirah} is a curses based terminal ebook
> reader that
> +can display ebooks in the usual way or with Rapid Serial Visual
> Presentation, a
> +method to enable speedreading by showing the text word by word at
> configurable
> +speeds.")
> +  (license license:gpl2+)))
> --  
> 2.37.2
>

bug#57744: [PATCH v3 3/3] gnu: Add shirah.

[Christopher Baines]

[-- Attachment #1: Type: text/plain, Size: 635 bytes --]


Mathieu <matf@disr.it> writes:

> Thanks for clarifying! Shirah does not include a license file indeed,
> but the end of the README clarifies the intent of the author: they say
> we can use gpl2 or any later version at our convenience. "gpl2+"
> indeed looks more relevant then since it is listed in one of the
> source files, as you found.
>
> Hopefully the patchset v3 is okay (I had to reset and restart from
> scratch, I could not figure out how to rebase v3 into three clean
> commits if starting from v2).

Thanks, I've pushed these three patches to master now as
eb9a39c1b75a60fe3946496bb2eee8f32dbf09cd.

Thanks again,

Chris

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 987 bytes --]