[bug#46616] [PATCH] gnu: Add python-tldr.

[bug#46616] [PATCH] gnu: Add python-tldr.

[Tanguy Le Carrour]

* gnu/packages/python-xyz.scm (python-tldr): New variable.
---
 gnu/packages/python-xyz.scm | 28 +++++++++++++++++++++++++++-
 1 file changed, 27 insertions(+), 1 deletion(-)

diff --git a/gnu/packages/python-xyz.scm b/gnu/packages/python-xyz.scm
index a504bb521b..b315d5f634 100644
--- a/gnu/packages/python-xyz.scm
+++ b/gnu/packages/python-xyz.scm
@@ -66,7 +66,7 @@
 ;;; Copyright © 2019 Jacob MacDonald <jaccarmac@gmail.com>
 ;;; Copyright © 2019, 2020 Giacomo Leidi <goodoldpaul@autistici.org>
 ;;; Copyright © 2019 Wiktor Żelazny <wzelazny@vurv.cz>
-;;; Copyright © 2019, 2020 Tanguy Le Carrour <tanguy@bioneland.org>
+;;; Copyright © 2019, 2020, 2021 Tanguy Le Carrour <tanguy@bioneland.org>
 ;;; Copyright © 2019 Mădălin Ionel Patrașcu <madalinionel.patrascu@mdc-berlin.de>
 ;;; Copyright © 2020 Riku Viitanen <riku.viitanen@protonmail.com>
 ;;; Copyright © 2020 Jakub Kądziołka <kuba@kadziolka.net>
@@ -19267,6 +19267,32 @@ Public Suffix List's private domains as well.")
 (define-public python2-tldextract
   (package-with-python2 python-tldextract))
 
+(define-public python-tldr
+  (package
+    (name "python-tldr")
+    (version "1.2.0")
+    (source
+      (origin
+        (method url-fetch)
+        (uri (pypi-uri "tldr" version))
+        (sha256
+         (base32
+          "00h43xjrzrayy1gysvmql5kfabk2d8xraih68d41616brdvb1xvf"))))
+    (build-system python-build-system)
+    (native-inputs
+     `(("python-pytest" ,python-pytest)
+       ("python-pytest-runner" ,python-pytest-runner)))
+    (propagated-inputs
+     `(("python-argcomplete" ,python-argcomplete)
+       ("python-colorama" ,python-colorama)
+       ("python-termcolor" ,python-termcolor)))
+    (home-page "https://github.com/tldr-pages/tldr-python-client")
+    (synopsis "Python command-line client for tldr pages")
+    (description "This package provides the `tldr' command allowing users
+to view `tldr' pages from a shell.  The `tldr' pages are a community effort
+to simplify the man pages with practical examples.")
+    (license license:expat))) ; MIT license
+
 (define-public python-nodeenv
   (package
     (name "python-nodeenv")
-- 
2.30.0

[bug#46616] [PATCH] gnu: Add python-tldr.

[Vinicius Monego]

Hi,

Em qui, 2021-02-18 às 15:06 +0100, Tanguy Le Carrour escreveu:
> * gnu/packages/python-xyz.scm (python-tldr): New variable.
> ---
>  gnu/packages/python-xyz.scm | 28 +++++++++++++++++++++++++++-

[...]

> +(define-public python-tldr
> +  (package
> +    (name "python-tldr")

I noticed that this program is a command line tool. It should be named
'tldr' only and be moved to another file. Perhaps to man.scm?

> +    (source
> +      (origin
> +        (method url-fetch)
> +        (uri (pypi-uri "tldr" version))
> +        (sha256
> +         (base32
> +          "00h43xjrzrayy1gysvmql5kfabk2d8xraih68d41616brdvb1xvf"))))
> +    (build-system python-build-system)
> +    (native-inputs
> +     `(("python-pytest" ,python-pytest)
> +       ("python-pytest-runner" ,python-pytest-runner)))

The tests for this one are not distributed in the PyPI release. Could
you source from the homepage instead?

There is one test that tries to open a network connection, it will have
to be skipped.

> +    (propagated-inputs
> +     `(("python-argcomplete" ,python-argcomplete)
> +       ("python-colorama" ,python-colorama)
> +       ("python-termcolor" ,python-termcolor)))

If it is only a command line tool, inputs should be normal inputs here.

> +    (description "This package provides the `tldr' command allowing
> users
> +to view `tldr' pages from a shell.  The `tldr' pages are a community
> effort
> +to simplify the man pages with practical examples.")

The linter made this complaint for the description: "use @code or
similar ornament instead of quotes".

LGTM otherwise.

Could you make these changes and send a v2 with version 1.2.1?

Vinicius

[bug#46616] [PATCH] gnu: Add python-tldr.

[Tanguy LE CARROUR]

Hi Vinicius,

Thanks for reviewing this patch, and sorry for the late answer!


Excerpts from Vinicius Monego's message of May 23, 2021 11:15 pm:
> Em qui, 2021-02-18 às 15:06 +0100, Tanguy Le Carrour escreveu:
>> * gnu/packages/python-xyz.scm (python-tldr): New variable.
>> ---
>>  gnu/packages/python-xyz.scm | 28 +++++++++++++++++++++++++++-
> 
> [...]
> 
>> +(define-public python-tldr
>> +  (package
>> +    (name "python-tldr")
> 
> I noticed that this program is a command line tool. It should be named
> 'tldr' only and be moved to another file. Perhaps to man.scm?

Your suggestions make sense, but there's another `tldr` client.
Namely `ghc-tldr`. It's defined in `gnu/packages/haskell-xyz.scm`.
If it's okay with you, I'll leave `python-tldr` in `gnu/packages/python-xyz.scm`.


>> +    (source
>> +      (origin
>> +        (method url-fetch)
>> +        (uri (pypi-uri "tldr" version))
>> +        (sha256
>> +         (base32
>> +          "00h43xjrzrayy1gysvmql5kfabk2d8xraih68d41616brdvb1xvf"))))
>> +    (build-system python-build-system)
>> +    (native-inputs
>> +     `(("python-pytest" ,python-pytest)
>> +       ("python-pytest-runner" ,python-pytest-runner)))
> 
> The tests for this one are not distributed in the PyPI release. Could
> you source from the homepage instead?
> 
> There is one test that tries to open a network connection, it will have
> to be skipped.

Done.


> 
>> +    (propagated-inputs
>> +     `(("python-argcomplete" ,python-argcomplete)
>> +       ("python-colorama" ,python-colorama)
>> +       ("python-termcolor" ,python-termcolor)))
> 
> If it is only a command line tool, inputs should be normal inputs here.

Done.


>> +    (description "This package provides the `tldr' command allowing
>> users
>> +to view `tldr' pages from a shell.  The `tldr' pages are a community
>> effort
>> +to simplify the man pages with practical examples.")
> 
> The linter made this complaint for the description: "use @code or
> similar ornament instead of quotes".

Done.


The new patch is following in another email…

Regards,

-- 
Tanguy

[bug#46616] [PATCH v2] gnu: Add python-tldr.

[Tanguy Le Carrour]

* gnu/packages/python-xyz.scm (python-tldr): New variable.
---
 gnu/packages/python-xyz.scm | 38 ++++++++++++++++++++++++++++++++++++-
 1 file changed, 37 insertions(+), 1 deletion(-)

diff --git a/gnu/packages/python-xyz.scm b/gnu/packages/python-xyz.scm
index a4fe31a01f..bc8c2133f5 100644
--- a/gnu/packages/python-xyz.scm
+++ b/gnu/packages/python-xyz.scm
@@ -66,7 +66,7 @@
 ;;; Copyright © 2019 Jacob MacDonald <jaccarmac@gmail.com>
 ;;; Copyright © 2019, 2020 Giacomo Leidi <goodoldpaul@autistici.org>
 ;;; Copyright © 2019 Wiktor Żelazny <wzelazny@vurv.cz>
-;;; Copyright © 2019, 2020 Tanguy Le Carrour <tanguy@bioneland.org>
+;;; Copyright © 2019, 2020, 2021 Tanguy Le Carrour <tanguy@bioneland.org>
 ;;; Copyright © 2019, 2021 Mădălin Ionel Patrașcu <madalinionel.patrascu@mdc-berlin.de>
 ;;; Copyright © 2020 Riku Viitanen <riku.viitanen@protonmail.com>
 ;;; Copyright © 2020 Jakub Kądziołka <kuba@kadziolka.net>
@@ -20825,6 +20825,42 @@ Public Suffix List's private domains as well.")
 (define-public python2-tldextract
   (package-with-python2 python-tldextract))
 
+(define-public python-tldr
+  (package
+    (name "python-tldr")
+    (version "1.2.1")
+    (source
+     (origin
+       ;; There's no test in PyPI.
+       (method git-fetch)
+       (uri (git-reference
+             (url "https://github.com/tldr-pages/tldr-python-client")
+             (commit version)))
+       (file-name (git-file-name name version))
+       (sha256
+        (base32 "0n9wqvjxspm18vlxf9j9slrcydshk4rkv5nwkrqhfq606n6zvks4"))))
+    (build-system python-build-system)
+    (arguments
+     `(#:phases
+       (modify-phases %standard-phases
+         (replace 'check
+           (lambda _
+             ;; This test fails. It tries to open a network socket.
+             (invoke "pytest" "-vv" "-k" "not test_error_message"))))))
+    (native-inputs
+     `(("python-pytest" ,python-pytest)
+       ("python-pytest-runner" ,python-pytest-runner)))
+    (inputs
+     `(("python-argcomplete" ,python-argcomplete)
+       ("python-colorama" ,python-colorama)
+       ("python-termcolor" ,python-termcolor)))
+    (home-page "https://github.com/tldr-pages/tldr-python-client")
+    (synopsis "Python command-line client for tldr pages")
+    (description "This package provides the @code{tldr} command allowing users
+to view @code{tldr} pages from a shell.  The `tldr' pages are a community effort
+to simplify the man pages with practical examples.")
+    (license license:expat))) ; MIT license
+
 (define-public python-nodeenv
   (package
     (name "python-nodeenv")
-- 
2.31.1

bug#46616: [PATCH v2] gnu: Add python-tldr.

[Efraim Flashner]

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

Thanks. I changed the 'check phase so that the tests can be skipped if
desired.

Patch pushed!

-- 
Efraim Flashner   <efraim@flashner.co.il>   אפרים פלשנר
GPG key = A28B F40C 3E55 1372 662D  14F7 41AA E7DC CA3D 8351
Confidentiality cannot be guaranteed on emails sent or received unencrypted

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

[bug#46616] [PATCH v2] gnu: Add python-tldr.

[Tanguy LE CARROUR]

Excerpts from Efraim Flashner's message of July 20, 2021 9:12 pm:
> Thanks. I changed the 'check phase so that the tests can be skipped if
> desired.
> 
> Patch pushed!

Thanks!

Best regards,

-- 
Tanguy