[PATCH 0/2] Add quickswitch for i3

[PATCH 0/2] Add quickswitch for i3

[Ivan Vilata i Balaguer]

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

Hi everyone,

The following two patches add the [quickswitch for i3][] package.  It
depends on [i3-py][], which I renamed to ``python-i3``.  The quickswitch
package is named ``i3-quickswitch``.  I hope I got the naming right,
they're also the first packages I add to Guix, so please tell if I did
something wrong!`:)`

[quickswitch for i3]: https://github.com/proxypoke/quickswitch-for-i3
[i3-py]: https://github.com/ziberna/i3-py

Cheers,

-- 
Ivan Vilata i Balaguer -- https://elvil.net/

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

[PATCH 1/2] gnu: python: Add python-i3.

[Ivan Vilata i Balaguer]

[-- Attachment #1: 0001-gnu-python-Add-python-i3.patch --]
[-- Type: text/plain, Size: 1680 bytes --]

From 3c39ddc7124c33ea0abe2d35a293b79942bf32b6 Mon Sep 17 00:00:00 2001
From: Ivan Vilata-i-Balaguer <ivan@selidor.net>
Date: Wed, 14 Sep 2016 08:28:22 +0200
Subject: [PATCH 1/2] gnu: python: Add python-i3.

* gnu/packages/python.scm (python-i3, python2-i3): New variables.
---
 gnu/packages/python.scm | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/gnu/packages/python.scm b/gnu/packages/python.scm
index e2e1ec2..1691449 100644
--- a/gnu/packages/python.scm
+++ b/gnu/packages/python.scm
@@ -9012,6 +9012,31 @@ and parameters in Python 2 source code.  These refactorings can also be applied
 to occurences in strings and comments.")
     (license license:gpl2)))
 
+(define-public python-i3
+  (package
+    (name "python-i3")
+    (version "0.6.4")
+    (source
+     (origin
+       (method url-fetch)
+       (uri (pypi-uri "i3-py" version))
+       (sha256
+        (base32
+         "1sgl438jrb4cdyl7hbc3ymwsf7y3zy09g1gh7ynilxpllp37jc8y"))))
+    (build-system python-build-system)
+    ;; No tests yet.
+    (arguments '(#:tests? #f))
+    (home-page "https://github.com/ziberna/i3-py")
+    (synopsis "Python interface to the i3 window manager")
+    (description "This package allows you to interact from a Python program
+with the i3 window manager via its IPC socket.  It can send commands and other
+kinds of messages to i3, select the affected containers, filter results and
+subscribe to events.")
+    (license license:gpl3+)))
+
+(define-public python2-i3
+  (package-with-python2 python-i3))
+
 (define-public python-py3status
   (package
     (name "python-py3status")
-- 
2.10.0


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

Re: [PATCH 1/2] gnu: python: Add python-i3.

[Brendan Tildesley]

On 2016-09-14 19:16, Ivan Vilata i Balaguer wrote:

This is version 0.6.4, but the git repo has a few small updates since
then, and has bumbed the version to 0.6.5. Being 4 years old, probably
this is not going to find it's way to pypi? Other than that I can't see
issues with the package. Perhaps it is not significant to matter?

Re: [PATCH 1/2] gnu: python: Add python-i3.

[Ivan Vilata i Balaguer]

Brendan Tildesley (2016-09-14 20:17:34 +1000) wrote:

> On 2016-09-14 19:16, Ivan Vilata i Balaguer wrote:
> 
> This is version 0.6.4, but the git repo has a few small updates since
> then, and has bumbed the version to 0.6.5. Being 4 years old, probably
> this is not going to find it's way to pypi? Other than that I can't
> see issues with the package. Perhaps it is not significant to matter?

Well observed, I opened a new issue in case the developer is still
around: <https://github.com/ziberna/i3-py/issues/22>.

-- 
Ivan Vilata i Balaguer -- https://elvil.net/

Re: [PATCH 1/2] gnu: python: Add python-i3.

[Leo Famulari]

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

On Wed, Sep 14, 2016 at 11:16:38AM +0200, Ivan Vilata i Balaguer wrote:
> Subject: [PATCH 1/2] gnu: python: Add python-i3.
> 
> * gnu/packages/python.scm (python-i3, python2-i3): New variables.

Thank you for this patch!

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

I think the package should be named python-i3-py because this will be
less confusing for anyone looking for i3-py.

> +    (version "0.6.4")

As Brendan pointed out, there is a later version in the Git repo.
Although we prefer to fetch from PyPi when all else is equal, we should
package the latest version available. There is an example of packaging
from Git when there is a version number but no tags in the darkhttpd
package definition.

> +    (build-system python-build-system)

Also, it would be nice to include the README.md in
'share/doc/python-i3-py', since there's no other documentation. This can
be done in a build phase after the install phase. Please reply here or
ask on #guix on Freenode if you get stuck.

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

[PATCH 2/2] gnu: python: Add i3-quickswitch.

[Ivan Vilata i Balaguer]

[-- Attachment #1: 0002-gnu-python-Add-i3-quickswitch.patch --]
[-- Type: text/plain, Size: 2030 bytes --]

From 621739c63f132115ee923da7bb61ff87844345f4 Mon Sep 17 00:00:00 2001
From: Ivan Vilata-i-Balaguer <ivan@selidor.net>
Date: Wed, 14 Sep 2016 11:00:25 +0200
Subject: [PATCH 2/2] gnu: python: Add i3-quickswitch.

* gnu/packages/python.scm (i3-quickswitch): New variable.
---
 gnu/packages/python.scm | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/gnu/packages/python.scm b/gnu/packages/python.scm
index 1691449..c032e8d 100644
--- a/gnu/packages/python.scm
+++ b/gnu/packages/python.scm
@@ -76,6 +76,7 @@
   #:use-module (gnu packages readline)
   #:use-module (gnu packages sdl)
   #:use-module (gnu packages statistics)
+  #:use-module (gnu packages suckless)
   #:use-module (gnu packages tex)
   #:use-module (gnu packages texinfo)
   #:use-module (gnu packages tls)
@@ -9037,6 +9038,31 @@ subscribe to events.")
 (define-public python2-i3
   (package-with-python2 python-i3))
 
+(define-public i3-quickswitch
+  (package
+    (name "i3-quickswitch")
+    (version "2.1")
+    (source
+     (origin
+       (method url-fetch)
+       (uri (pypi-uri "quickswitch-i3" version))
+       (sha256
+        (base32
+         "00k2gjrq7krzaf3b1r8snqjqa1sjnb3i3yvik165d3nj2sf5wypm"))))
+    (build-system python-build-system)
+    ;; No tests yet.
+    (arguments '(#:tests? #f))
+    (propagated-inputs
+     `(("python-i3" ,python-i3)
+       ("dmenu" ,dmenu)))
+    (home-page "https://github.com/proxypoke/quickswitch-for-i3")
+    (synopsis "Quickly change to and locate windows in the i3 window manager")
+    (description "This utility for the i3 window manager allows you to quickly
+switch to and locate windows on all your workspaces, using an interactive
+dmenu prompt.  It has since gained a lot of other functionality to make
+working with i3 even more efficient.")
+    (license (license:non-copyleft "http://www.wtfpl.net/txt/copying/"))))
+
 (define-public python-py3status
   (package
     (name "python-py3status")
-- 
2.10.0


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

Re: [PATCH 2/2] gnu: python: Add i3-quickswitch.

[Brendan Tildesley]

On 2016-09-14 19:17, Ivan Vilata i Balaguer wrote:

Welcome to Guix. I tested this out in i3 and it works just fine. I may
end up using it. the latest version seems to be 2.2, but I see you
commented on that on the github, as it is not in pypi yet. Do we prefer
to use pypi or directly source upstream for packages? With 80k+ packages
in pypi, I'm unsure. Someone else will need to review this as I don't
have commit access.

Re: [PATCH 2/2] gnu: python: Add i3-quickswitch.

[Leo Famulari]

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

On Wed, Sep 14, 2016 at 11:17:24AM +0200, Ivan Vilata i Balaguer wrote:
> Subject: [PATCH 2/2] gnu: python: Add i3-quickswitch.
> 
> * gnu/packages/python.scm (i3-quickswitch): New variable.

Cool, this works :)

> +(define-public i3-quickswitch
> +  (package
> +    (name "i3-quickswitch")

Again, I think that we should stay closer to the upstream name, in this
case "quickswitch-for-i3".

> +    (build-system python-build-system)

Also again, it would be nice to include README.rst.

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

Re: [PATCH 2/2] gnu: python: Add i3-quickswitch.

[Ivan Vilata i Balaguer]

Leo Famulari (2016-09-16 01:46:37 -0400) wrote:

> On Wed, Sep 14, 2016 at 11:17:24AM +0200, Ivan Vilata i Balaguer wrote:
> > Subject: [PATCH 2/2] gnu: python: Add i3-quickswitch.
> > 
> > * gnu/packages/python.scm (i3-quickswitch): New variable.
> 
> Cool, this works :)
> 
> > +(define-public i3-quickswitch
> > +  (package
> > +    (name "i3-quickswitch")
> 
> Again, I think that we should stay closer to the upstream name, in this
> case "quickswitch-for-i3".
> 
> > +    (build-system python-build-system)
> 
> Also again, it would be nice to include README.rst.

Thanks Leo and Brendan for your comments, I'm writing new versions of
the packages following your suggestions, unfortunately I found out that
``quickswitch.py`` makes use of the Debian-specific ``which`` tool, so
I'm also working on including a small patch (which I've also
[reported][1] for completeness).  More things to learn!`;)`

[1]: https://github.com/proxypoke/quickswitch-for-i3/pull/28

-- 
Ivan Vilata i Balaguer -- https://elvil.net/

Re: [PATCH 2/2] gnu: python: Add i3-quickswitch.

[Ivan Vilata i Balaguer]

Ivan Vilata i Balaguer (2016-09-19 11:24:02 +0200) wrote:

> Thanks Leo and Brendan for your comments, I'm writing new versions of
> the packages following your suggestions, unfortunately I found out
> that ``quickswitch.py`` makes use of the Debian-specific ``which``
> tool, so I'm also working on including a small patch (which I've also
> [reported][1] for completeness).  More things to learn!`;)`
> 
> [1]: https://github.com/proxypoke/quickswitch-for-i3/pull/28

BTW, I'm considering whether I should keep ``python-i3-py`` and
``quickswitch-for-i3`` in ``(gnu packages python)`` or I should rather
move them to ``(gnu packages wm)``, since their sole use is strongly
bound to the i3 window manager.  Any suggestions?

Thanks,

-- 
Ivan Vilata i Balaguer -- https://elvil.net/

Re: [PATCH 2/2] gnu: python: Add i3-quickswitch.

[Leo Famulari]

On Mon, Sep 19, 2016 at 11:28:09AM +0200, Ivan Vilata i Balaguer wrote:
> Ivan Vilata i Balaguer (2016-09-19 11:24:02 +0200) wrote:
> 
> > Thanks Leo and Brendan for your comments, I'm writing new versions of
> > the packages following your suggestions, unfortunately I found out
> > that ``quickswitch.py`` makes use of the Debian-specific ``which``
> > tool, so I'm also working on including a small patch (which I've also
> > [reported][1] for completeness).  More things to learn!`;)`
> > 
> > [1]: https://github.com/proxypoke/quickswitch-for-i3/pull/28
> 
> BTW, I'm considering whether I should keep ``python-i3-py`` and
> ``quickswitch-for-i3`` in ``(gnu packages python)`` or I should rather
> move them to ``(gnu packages wm)``, since their sole use is strongly
> bound to the i3 window manager.  Any suggestions?

I think it makes sense to put them in (gnu packages wm).

Re: [PATCH 2/2] gnu: python: Add i3-quickswitch.

[Hartmut Goebel]

[-- Attachment #1.1: Type: text/plain, Size: 789 bytes --]

Am 19.09.2016 um 11:24 schrieb Ivan Vilata i Balaguer:
> > > * gnu/packages/python.scm (i3-quickswitch): New variable.

Sorry for being late in this discussion.

I think, this should *not* go into python.scm, only because it is
implemented in python.
IMO this should go into  gnu/packages/wm.scm where i3-wm and i3status
life, since it is related to the window manager.


-- 
Schönen Gruß
Hartmut Goebel
Dipl.-Informatiker (univ), CISSP, CSSLP, ISO 27001 Lead Implementer
Information Security Management, Security Governance, Secure Software
Development

Goebel Consult, Landshut
http://www.goebel-consult.de

Blog:
http://www.goebel-consult.de/blog/digitale-burgerrechte-in-der-ara-snowden
Kolumne: http://www.cissp-gefluester.de/2011-11-in-troja-nichts-neues


[-- Attachment #1.2: Type: text/html, Size: 2024 bytes --]

[-- Attachment #2: S/MIME Cryptographic Signature --]
[-- Type: application/pkcs7-signature, Size: 2430 bytes --]

Re: [PATCH 2/2] gnu: python: Add i3-quickswitch.

[Leo Famulari]

On Mon, Sep 19, 2016 at 11:24:02AM +0200, Ivan Vilata i Balaguer wrote:
> Thanks Leo and Brendan for your comments, I'm writing new versions of
> the packages following your suggestions, unfortunately I found out that
> ``quickswitch.py`` makes use of the Debian-specific ``which`` tool, so
> I'm also working on including a small patch (which I've also
> [reported][1] for completeness).  More things to learn!`;)`

`which` is not a Debian tool, and we do sometimes have to add it as an
input to packages. Our package name is 'which'. It might be enough to
just add the 'which' package to quickswitch-for-i3's inputs (or
native-inputs, if `which` is only used while building).

www.gnu.org/software/which/

Re: [PATCH 2/2] gnu: python: Add i3-quickswitch.

[Ivan Vilata i Balaguer]

Leo Famulari (2016-09-19 17:39:37 -0400) wrote:

> On Mon, Sep 19, 2016 at 11:24:02AM +0200, Ivan Vilata i Balaguer wrote:
> > Thanks Leo and Brendan for your comments, I'm writing new versions
> > of the packages following your suggestions, unfortunately I found
> > out that ``quickswitch.py`` makes use of the Debian-specific
> > ``which`` tool, so I'm also working on including a small patch
> > (which I've also [reported][1] for completeness).  More things to
> > learn!`;)`
> 
> `which` is not a Debian tool, and we do sometimes have to add it as an
> input to packages. Our package name is 'which'. It might be enough to
> just add the 'which' package to quickswitch-for-i3's inputs (or
> native-inputs, if `which` is only used while building).
> 
> www.gnu.org/software/which/

Oh my, I missed the actual ``which`` package, sorry!  Anyway it's only
used to check that ``dmenu`` is there, and the function that does the
check is pretty broken anyway, causing other errors (see [my PR][1]).
However I found a [simpler PR][2] that fixes all the errors and also
does away with the dependency on ``which``, so I closed my PR and will
use the latter.

[1]: https://github.com/proxypoke/quickswitch-for-i3/pull/28
[2]: https://github.com/proxypoke/quickswitch-for-i3/pull/24

Leo Famulari (2016-09-19 17:42:18 -0400) wrote:

> On Mon, Sep 19, 2016 at 08:20:26PM +1000, Brendan Tildesley wrote:
> > I'm not a fan of "quickswitch-for-i3" and "python-i3-py". Perhaps a
> > better solution is to ensure "i3-py" in the description or synopsis
> > so that `guix package -s' finds it. As for quickswitch, isn't the
> > upstream name also simply "quickswitch-i3"?
> 
> Our packaging guidelines say that we should use the "project name chosen
> upstream" [0], which in this case appears to be quickswitch-for-i3 [1].

The PyPi package, the ``setup(name=...)`` argument in ``setup.py`` and
the content of the readme use ``quickswitch-i3`` as the project short
name, while the GitHub URL and readme title use "quickswitch for i3" as
a more descriptive name.  In this case I consider the former name to be
the "official" short name, also compatible with ``pip`` and others.  Is
there any other similar case already in Guix?

> And python-i3-py does follow our conventions for naming Python modules
> [2].
> 
> [0]
> https://www.gnu.org/software/guix/manual/html_node/Package-Naming.html
> 
> [1]
> https://github.com/proxypoke/quickswitch-for-i3
> 
> [2]
> https://www.gnu.org/software/guix/manual/html_node/Python-Modules.html

So I can do a third iteration with the PR#24 patch and package names
``python-i3-py`` and ``quickswitch-i3``.  What do you think?

One more time, thanks for your help and comments!

-- 
Ivan Vilata i Balaguer -- https://elvil.net/

Re: [PATCH 2/2] gnu: python: Add i3-quickswitch.

[Brendan Tildesley]

Leo Famulari 於 2016-09-16 15:46 寫道:
> On Wed, Sep 14, 2016 at 11:17:24AM +0200, Ivan Vilata i Balaguer wrote:
>> Subject: [PATCH 2/2] gnu: python: Add i3-quickswitch.
>>
>> * gnu/packages/python.scm (i3-quickswitch): New variable.
> Cool, this works :)
>
>> +(define-public i3-quickswitch
>> +  (package
>> +    (name "i3-quickswitch")
> Again, I think that we should stay closer to the upstream name, in this
> case "quickswitch-for-i3".
I'm not a fan of "quickswitch-for-i3" and "python-i3-py". Perhaps a
better solution is to ensure "i3-py" in the description or synopsis so
that `guix package -s' finds it. As for quickswitch, isn't the upstream
name also simply "quickswitch-i3"?
>> +    (build-system python-build-system)
> Also again, it would be nice to include README.rst.

Re: [PATCH 2/2] gnu: python: Add i3-quickswitch.

[Leo Famulari]

On Mon, Sep 19, 2016 at 08:20:26PM +1000, Brendan Tildesley wrote:
> I'm not a fan of "quickswitch-for-i3" and "python-i3-py". Perhaps a
> better solution is to ensure "i3-py" in the description or synopsis so
> that `guix package -s' finds it. As for quickswitch, isn't the upstream
> name also simply "quickswitch-i3"?

Our packaging guidelines say that we should use the "project name chosen
upstream" [0], which in this case appears to be quickswitch-for-i3 [1].

And python-i3-py does follow our conventions for naming Python modules
[2].

[0]
https://www.gnu.org/software/guix/manual/html_node/Package-Naming.html

[1]
https://github.com/proxypoke/quickswitch-for-i3

[2]
https://www.gnu.org/software/guix/manual/html_node/Python-Modules.html

Re: [PATCH 2/2] gnu: python: Add i3-quickswitch.

[Hartmut Goebel]

[-- Attachment #1.1: Type: text/plain, Size: 861 bytes --]

Am 19.09.2016 um 23:42 schrieb Leo Famulari:
> Our packaging guidelines say that we should use the "project name chosen
> upstream" [0], which in this case appears to be quickswitch-for-i3 [1].
The project itself is not consistent about this. While the title of the
readme says "quickswitch-for-i3" the remaining text of the redme says
"quickswitch-i3". The Readme also says that at PyPI and AUR teh project
is both called "quickswitch-i3"

-- 
Schönen Gruß
Hartmut Goebel
Dipl.-Informatiker (univ), CISSP, CSSLP, ISO 27001 Lead Implementer
Information Security Management, Security Governance, Secure Software
Development

Goebel Consult, Landshut
http://www.goebel-consult.de

Blog:
http://www.goebel-consult.de/blog/warum-sie-nicht-perl-programmiern-sollten
Kolumne: http://www.cissp-gefluester.de/2012-02-bring-your-own-life-glosse


[-- Attachment #1.2: Type: text/html, Size: 1991 bytes --]

[-- Attachment #2: S/MIME Cryptographic Signature --]
[-- Type: application/pkcs7-signature, Size: 2430 bytes --]

Re: [PATCH 0/2] Add quickswitch for i3

[Leo Famulari]

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

On Wed, Sep 14, 2016 at 11:12:29AM +0200, Ivan Vilata i Balaguer wrote:
> Hi everyone,

Hi!

> The following two patches add the [quickswitch for i3][] package.  It
> depends on [i3-py][], which I renamed to ``python-i3``.  The quickswitch
> package is named ``i3-quickswitch``.  I hope I got the naming right,
> they're also the first packages I add to Guix, so please tell if I did
> something wrong!`:)`

Generally, we stick to the upstream name, except for the case of Python
Perl modules... and a few other cases. User facing applications like
quickswitch typically keep their upstream names. There's some more info
in the manual, section 7.6.2 Package Naming:

https://www.gnu.org/software/guix/manual/html_node/Package-Naming.html

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