GNU bug report logs - #74864
[PATCH] gnu: Add adl-submit.py

Previous Next

To reply to this bug, email your comments to 74864 AT debbugs.gnu.org.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Denis 'GNUtoo' Carikli <GNUtoo <at> cyberdimension.org>
To: guix-patches <at> gnu.org
Cc: Denis 'GNUtoo' Carikli <GNUtoo <at> cyberdimension.org>
Subject: [PATCH] gnu: Add adl-submit.py
Date: Sat, 14 Dec 2024 02:25:30 +0100

* gnu/packages/calendar.scm (adl-submit.py): New variable.

Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo <at> cyberdimension.org>
Change-Id: Icd9438fbaf2c53635989fb8cfb443d2c3e541eff
---
 gnu/packages/calendar.scm | 44 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)

diff --git a/gnu/packages/calendar.scm b/gnu/packages/calendar.scm
index 6717db867f..069e3c05ca 100644
--- a/gnu/packages/calendar.scm
+++ b/gnu/packages/calendar.scm
@@ -12,6 +12,7 @@
 ;;; Copyright © 2020 Peng Mei Yu <pengmeiyu <at> riseup.net>
 ;;; Copyright © 2021 Wamm K. D. <jaft.r <at> outlook.com>
 ;;; Copyright © 2022 Maxim Cournoyer <maxim.cournoyer <at> gmail.com>
+;;; Copyright © 2024 Denis 'GNUtoo' Carikli <GNUtoo <at> cyberdimension.org>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -56,6 +57,7 @@ (define-module (gnu packages calendar)
   #:use-module (gnu packages pkg-config)
   #:use-module (gnu packages python)
   #:use-module (gnu packages python-build)
+  #:use-module (gnu packages python-web)
   #:use-module (gnu packages python-xyz)
   #:use-module (gnu packages qt)
   #:use-module (gnu packages sphinx)
@@ -65,6 +67,48 @@ (define-module (gnu packages calendar)
   #:use-module (gnu packages xml)
   #:use-module (srfi srfi-26))
 
+(define-public adl-submit.py
+  (let ((revision "1")
+        (commit "e20998c17475e64676173828385f22a6d5801240"))
+    (package
+     (name "adl-submit.py")
+     (version (git-version "1.0" revision commit))
+     (source
+      (origin
+       (method git-fetch)
+       (uri (git-reference
+             (url "https://framagit.org/agenda-libre/agenda-libre-ruby.git")
+             (commit commit)))
+       (file-name (git-file-name name version))
+       (sha256
+        (base32 "1jpasv7skpbi20674f23kbgw2fj78ywhnd542cwgkc65v2s6s4lh"))))
+     (build-system gnu-build-system)
+    (arguments
+     (list
+      #:tests? #f ; No tests
+      #:phases
+      #~(modify-phases %standard-phases
+          (delete 'configure)
+          (delete 'build)
+          (replace 'install
+            (lambda _
+              (install-file
+               "public/adl-submit.py" (string-append #$output "/bin"))
+              (wrap-program (string-append #$output "/bin/adl-submit.py")
+                `("GUIX_PYTHONPATH" ":"
+                  prefix (,(getenv "GUIX_PYTHONPATH")))))))))
+     (inputs (list python python-pycurl))
+     (home-page "https://www.agendadulibre.org")
+     (synopsis "Submit events to the Agenda Du Libre")
+     (description "adl-submit.py is a tool that can be used to submit events
+to any instance of the Agenda Du Libre (a web calendar originally meant for
+free software events).  Users can set fields through the command line or
+create an XML that can be submitted with the adl-submit.py tool.  While the
+Agenda Du Libre web application is available in multiple languages, most of
+the events on https://www.agendadulibre.org are in French and the
+adl-submit.py tool is only available in French.")
+     (license license:gpl2))))
+
 (define-public date
   ;; We make the same choice as the Arch package maintainer by choosing a
   ;; recent commit to fix some bugs.

base-commit: 0787a180b3ca64d3958438920ca1b58a2a27fba4
-- 
2.46.0

Message #8 received at 74864 <at> debbugs.gnu.org (full text, mbox):

From: Simon Tournier <zimon.toutoune <at> gmail.com>
To: Denis 'GNUtoo' Carikli <GNUtoo <at> cyberdimension.org>, 74864 <at> debbugs.gnu.org
Cc: Sharlatan Hellseher <sharlatanus <at> gmail.com>,
 Munyoki Kilyungi <me <at> bonfacemunyoki.com>, Lars-Dominik Braun <lars <at> 6xq.net>,
 jgart <jgart <at> dismail.de>, Marius Bakke <marius <at> gnu.org>,
 Tanguy Le Carrour <tanguy <at> bioneland.org>
Subject: Re: [bug#74864] [PATCH] gnu: Add adl-submit.py
Date: Thu, 16 Jan 2025 13:27:01 +0100

Hi Denis,

CC: Python team because it’s a Python script after all. :-)

On Sat, 14 Dec 2024 at 02:25, Denis 'GNUtoo' Carikli <GNUtoo <at> cyberdimension.org> wrote:

> * gnu/packages/calendar.scm (adl-submit.py): New variable.

Cool!  Thank you.


> +(define-public adl-submit.py

[...]

> +     (build-system gnu-build-system)
> +    (arguments
> +     (list
> +      #:tests? #f ; No tests
> +      #:phases
> +      #~(modify-phases %standard-phases
> +          (delete 'configure)
> +          (delete 'build)
> +          (replace 'install
> +            (lambda _
> +              (install-file
> +               "public/adl-submit.py" (string-append #$output "/bin"))
> +              (wrap-program (string-append #$output "/bin/adl-submit.py")
> +                `("GUIX_PYTHONPATH" ":"
> +                  prefix (,(getenv "GUIX_PYTHONPATH")))))))))

Since it “only“ copies ’public/adl-submit.py’, why not rely on
’copy-build-system’ instead?

Cheers,
simon

Message #11 received at 74864 <at> debbugs.gnu.org (full text, mbox):

From: Sharlatan Hellseher <sharlatanus <at> gmail.com>
To: 74864 <at> debbugs.gnu.org
Subject: [PATCH] gnu: Add adl-submit.py
Date: Thu, 16 Jan 2025 21:11:02 +0000

[Message part 1 (text/plain, inline)]

Hi,

I've checked the project on
<https://framagit.org/agenda-libre/agenda-libre-ruby>, and looks like a
full featured application where public/adl-submit.py is served by the
web server.

Question of interest, why we need to pack just one script out of the
whole project :-)?

--
Oleg

[signature.asc (application/pgp-signature, inline)]

Message #14 received at 74864 <at> debbugs.gnu.org (full text, mbox):

From: Denis 'GNUtoo' Carikli <GNUtoo <at> cyberdimension.org>
To: 74864 <at> debbugs.gnu.org
Cc: Denis 'GNUtoo' Carikli <GNUtoo <at> cyberdimension.org>
Subject: [PATCH v2] gnu: Add adl-submit.py
Date: Tue, 21 Jan 2025 18:18:23 +0100

* gnu/packages/calendar.scm (adl-submit.py): New variable.

Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo <at> cyberdimension.org>
Change-Id: Icd9438fbaf2c53635989fb8cfb443d2c3e541eff
---
 gnu/packages/calendar.scm | 42 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)

diff --git a/gnu/packages/calendar.scm b/gnu/packages/calendar.scm
index 6717db867f2..733ec823ba5 100644
--- a/gnu/packages/calendar.scm
+++ b/gnu/packages/calendar.scm
@@ -12,6 +12,7 @@
 ;;; Copyright © 2020 Peng Mei Yu <pengmeiyu <at> riseup.net>
 ;;; Copyright © 2021 Wamm K. D. <jaft.r <at> outlook.com>
 ;;; Copyright © 2022 Maxim Cournoyer <maxim.cournoyer <at> gmail.com>
+;;; Copyright © 2024 Denis 'GNUtoo' Carikli <GNUtoo <at> cyberdimension.org>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -35,6 +36,7 @@ (define-module (gnu packages calendar)
   #:use-module (guix git-download)
   #:use-module (guix packages)
   #:use-module (guix download)
+  #:use-module (guix build-system copy)
   #:use-module (guix build-system gnu)
   #:use-module (guix build-system go)
   #:use-module (guix build-system cmake)
@@ -56,6 +58,7 @@ (define-module (gnu packages calendar)
   #:use-module (gnu packages pkg-config)
   #:use-module (gnu packages python)
   #:use-module (gnu packages python-build)
+  #:use-module (gnu packages python-web)
   #:use-module (gnu packages python-xyz)
   #:use-module (gnu packages qt)
   #:use-module (gnu packages sphinx)
@@ -65,6 +68,45 @@ (define-module (gnu packages calendar)
   #:use-module (gnu packages xml)
   #:use-module (srfi srfi-26))
 
+(define-public adl-submit.py
+  (let ((revision "1")
+        (commit "e20998c17475e64676173828385f22a6d5801240"))
+    (package
+     (name "adl-submit.py")
+     (version (git-version "1.0" revision commit))
+     (source
+      (origin
+       (method git-fetch)
+       (uri (git-reference
+             (url "https://framagit.org/agenda-libre/agenda-libre-ruby.git")
+             (commit commit)))
+       (file-name (git-file-name name version))
+       (sha256
+        (base32 "1jpasv7skpbi20674f23kbgw2fj78ywhnd542cwgkc65v2s6s4lh"))))
+     (build-system copy-build-system)
+     (arguments
+      (list
+       #:install-plan
+       #~'(("public/adl-submit.py" "bin/adl-submit.py"))
+       #:phases
+       #~(modify-phases %standard-phases
+           (add-after 'install 'wrap-script
+             (lambda _
+               (wrap-program (string-append #$output "/bin/adl-submit.py")
+                 `("GUIX_PYTHONPATH" ":"
+                   prefix (,(getenv "GUIX_PYTHONPATH")))))))))
+     (inputs (list python python-pycurl))
+     (home-page "https://www.agendadulibre.org")
+     (synopsis "Submit events to the Agenda Du Libre")
+     (description "adl-submit.py is a tool that can be used to submit events
+to any instance of the Agenda Du Libre (a web calendar originally meant for
+free software events).  Users can set fields through the command line or
+create an XML that can be submitted with the adl-submit.py tool.  While the
+Agenda Du Libre web application is available in multiple languages, most of
+the events on https://www.agendadulibre.org are in French and the
+adl-submit.py tool is only available in French.")
+     (license license:gpl2))))
+
 (define-public date
   ;; We make the same choice as the Arch package maintainer by choosing a
   ;; recent commit to fix some bugs.

base-commit: 309ad9fcdacf732691f0220c4122757d9940b97d
-- 
2.46.0

Message #17 received at 74864 <at> debbugs.gnu.org (full text, mbox):

From: Denis 'GNUtoo' Carikli <GNUtoo <at> cyberdimension.org>
To: 74864 <at> debbugs.gnu.org, Sharlatan Hellseher <sharlatanus <at> gmail.com>
Subject: Re: [PATCH] gnu: Add adl-submit.py
Date: Thu, 23 Jan 2025 05:33:02 +0100

[Message part 1 (text/plain, inline)]

> Hi,
Hi,

> Question of interest, why we need to pack just one script out of the
> whole project :-)?
The issue is that the whole project is a web application that is
deployed at https://www.agendadulibre.org/ (it's basically a 
calendar for French free software events).

And I'm only interested in packaging a client that connects to that web
application to submit events.

The use case is that I find adl-submit.py really useful as we heavily
depend on adl-submit.py in a French free software user group (Parinux)
that I'm part of, and so I thought that maybe other people than me might
also need it as well (other people from Parinux, people organizing Guix
events in France around Paris because they also publish on the Agenda
du libre, etc).

This website is really central in the free software community in France.

If you need more details on the use case, our workflow at Parinux is
the following: we start by creating a new page with a new event (like
the install Party for the next month) on our SPIP website, usually by
cloning another event (like the install party from the previous month).

We have a custom SPIP extension that generates an xml file that is
compatible with the adl-submit.py tool.

So once the event is published, someone (usually the person
that published the event but not always) downloads that XML and runs
adl-submit.py on her computer to send it to the Agenda du libre.

Then people from the Agenda du libre (it's moderated) accept our event
and it gets published there as well.

So basically we're not really interested in hosting our own Agenda du
libre, we're only interested in sending events its most famous instance.

And at least for us it is crucial because people have very little time
to do such publication, and the Agenda du libre is also kind of
central, and so not publishing there or publishing very late means that
way less people go to the event, which is problematic.

I think that the use cases are relevant here because as I understand
the packages we add to Guix are expected to be maintained somehow, so I
think it makes more sense to add packages that people actually use or
depend on.

Also note that while I heavily depend on this package, I don't know how
many other people do or may want to.

> I've checked the project on
> <https://framagit.org/agenda-libre/agenda-libre-ruby>, and looks like
> a full featured application where public/adl-submit.py is served by
> the web server.
This is actually the case indeed.

This also complicates things: contributions to adl-submit.py need to
fit into this file because that file is also served by the web
application. 

This is why I didn't translate adl-submit.py in English before sending
a patch to add it in Guix.

So for instance I can't simply send a patch to adl-submit that uses
gettext to translate it in English as well because such modification
would make adl-submit.py depend on additional files.

Though maybe once it is packaged in Guix, a patch could still be made
to optionally add internationalization, and once/if it is merged in
adl-submit.py, the Guix package could then be updated to use this
optional internationalization feature, making all that a bit more
useful and easier for people that don't understand French to understand
what all that is about.

Also note that the agendadulibre.org website also works fine in
English, through not everything is translated. This can be relevant for
international conferences that take place in France for instance
(assuming they choose to use the Agenda du libre, as not all
International conferences do that in France).

PS: for some reasons I didn't get your mail, I just replied by
    copy-pasting it from debbugs.

Denis.

[Message part 2 (application/pgp-signature, inline)]

Message #20 received at 74864 <at> debbugs.gnu.org (full text, mbox):

From: Sharlatan Hellseher <sharlatanus <at> gmail.com>
To: 74864 <at> debbugs.gnu.org
Cc: GNUtoo <at> cyberdimension.org
Subject: [PATCH] gnu: Add adl-submit.py
Date: Thu, 23 Jan 2025 19:33:46 +0000

[Message part 1 (text/plain, inline)]

Hi,

> This also complicates things: contributions to adl-submit.py need to
> fit into this file because that file is also served by the web
> application.

What if someone would like to create a proper python package first by
taking that file and preparing pyproject.toml with all dependencies? It
would ease the live both for packaging and maintain, WDYT?

I may prepare the project based on that script, I guess the license
would let us do that, or propose maintainers of
<https://framagit.org/agenda-libre/agenda-libre-ruby> to ship it as
dedicated project with the same reason you described - it would help
make live more bright and shiny.

--
Thanks
Oleg

[signature.asc (application/pgp-signature, inline)]

Message #23 received at 74864 <at> debbugs.gnu.org (full text, mbox):

From: Denis 'GNUtoo' Carikli <GNUtoo <at> cyberdimension.org>
To: Sharlatan Hellseher <sharlatanus <at> gmail.com>
Cc: 74864 <at> debbugs.gnu.org
Subject: Re: [PATCH] gnu: Add adl-submit.py
Date: Wed, 29 Jan 2025 02:41:01 +0100

[Message part 1 (text/plain, inline)]

Hi,

On Thu, 23 Jan 2025 19:33:46 +0000
Sharlatan Hellseher <sharlatanus <at> gmail.com> wrote:
> > This also complicates things: contributions to adl-submit.py need to
> > fit into this file because that file is also served by the web
> > application.
> 
> What if someone would like to create a proper python package first by
> taking that file and preparing pyproject.toml with all dependencies?
> It would ease the live both for packaging and maintain, WDYT?
Thanks a lot for the suggestion, I've started doing that and I sent a
first version of 2 patch sets that goes together for that which are
here:
https://framagit.org/agenda-libre/agenda-libre-ruby/-/merge_requests/71
https://framagit.org/agenda-libre/agenda-libre-ruby/-/merge_requests/72

The discussion happens in the first merge request (71).

> I may prepare the project based on that script, I guess the license
> would let us do that, or propose maintainers of
> <https://framagit.org/agenda-libre/agenda-libre-ruby> to ship it as
> dedicated project with the same reason you described - it would help
> make live more bright and shiny.
I'm unsure this is a good idea or not as moving the adl-submit.py in a
separate repository might result in more maintenance for the Agenda du
libre maintainer.

However as I understand all major general purpose package managers
(Guix, Arch Linux's pacman, Gentoo's portage, Yocto's bitbake etc)
support changing directory during the build.

If we do that, would that create some undesirable side effect? For
instance would pip be able to build that? Would guix import work? What
about guix refresh or guix lint?

Since programming language package managers (like pip) tend to be more
strict than general purpose ones (like Guix), could that cause any
issues?

Denis.

[Message part 2 (application/pgp-signature, inline)]

Message #26 received at 74864 <at> debbugs.gnu.org (full text, mbox):

From: Denis 'GNUtoo' Carikli <GNUtoo <at> cyberdimension.org>
To: Sharlatan Hellseher <sharlatanus <at> gmail.com>
Cc: 74864 <at> debbugs.gnu.org
Subject: Re: [PATCH] gnu: Add adl-submit.py
Date: Mon, 24 Mar 2025 16:14:03 +0100

[Message part 1 (text/plain, inline)]

On Thu, 23 Jan 2025 19:33:46 +0000
Sharlatan Hellseher <sharlatanus <at> gmail.com> wrote:
> What if someone would like to create a proper python package first by
> taking that file and preparing pyproject.toml with all dependencies?
> It would ease the live both for packaging and maintain, WDYT?
I've discussed with the maintainer and at the end we decided to
do that, and the new repository is now here:

https://framagit.org/agenda-libre/adl-submit.git

I also somehow became co-maintainer (I wanted to avoid that) but we
didn't agree yet on how to handle new patches.

I'll try to see how to send an additional patch to adl-submit to rename
adl-submit.py in adl-submit and I'll then a new patch to Guix.

For the other planned improvements (like add an English translation)
I'll do that later on if I can find the time.

Denis.

[Message part 2 (application/pgp-signature, inline)]

Message #29 received at 74864 <at> debbugs.gnu.org (full text, mbox):

From: Denis 'GNUtoo' Carikli <GNUtoo <at> cyberdimension.org>
To: 74864 <at> debbugs.gnu.org, Sharlatan Hellseher <sharlatanus <at> gmail.com>,
 Simon Tournier <zimon.toutoune <at> gmail.com>
Cc: Denis 'GNUtoo' Carikli <GNUtoo <at> cyberdimension.org>
Subject: [PATCH v3] gnu: Add adl-submit.
Date: Sat, 10 May 2025 01:46:59 +0200

* gnu/packages/calendar.scm (adl-submit): New variable.

Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo <at> cyberdimension.org>
Change-Id: Icd9438fbaf2c53635989fb8cfb443d2c3e541eff
---
ChangeLog v2->v3:
* Updated copyright to 2025.
* Switch to a new repository that only has adl-submit and not
  the full Agenda Du Libre code.

  This simplifies license compliance because while the Agenda Du Libre
  web application was fully free it also pulled in compiled/minified
  JavaScript from other sources (probably with a script if I
  understood well the maintainer).

  This repository is co-maintained by both the Agenda Du Libre
  maintainer (Esharp) and me, though if I understood well, in practice
  the maintainer trusts me to do what's best and doesn't necessarily
  and only reviewed a bit the commits until the revision
  9c62c13ba35720b2d0fdbc37c19cbb55cef6d5c1 ("Add .gitignore.").
  
* Switch to a new git revision that uses the python build system. So
  we don't need to do any workarounds anymore in the Guix package.

  And beside some small fixes, it also has some improvements:

  * adl-submit.py was renamed to adl-submit and #!/usr/bin/python3 is
    now used as per Debian Guidelines on packaging python scripts.

  * All the authors copyrights are now added in the copyright header
    of the python script. This required to contact 2 authors to make
    sure who between them has copyright on a specific commit as they
    both collaborated together to do it.

  * The READMEs are now shipped as part of the documentation.

---
 gnu/packages/calendar.scm | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/gnu/packages/calendar.scm b/gnu/packages/calendar.scm
index ed7a13a2c9..84f83fe9c4 100644
--- a/gnu/packages/calendar.scm
+++ b/gnu/packages/calendar.scm
@@ -12,6 +12,7 @@
 ;;; Copyright © 2020 Peng Mei Yu <pengmeiyu <at> riseup.net>
 ;;; Copyright © 2021 Wamm K. D. <jaft.r <at> outlook.com>
 ;;; Copyright © 2022 Maxim Cournoyer <maxim.cournoyer <at> gmail.com>
+;;; Copyright © 2025 Denis 'GNUtoo' Carikli <GNUtoo <at> cyberdimension.org>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -56,6 +57,7 @@ (define-module (gnu packages calendar)
   #:use-module (gnu packages pkg-config)
   #:use-module (gnu packages python)
   #:use-module (gnu packages python-build)
+  #:use-module (gnu packages python-web)
   #:use-module (gnu packages python-xyz)
   #:use-module (gnu packages qt)
   #:use-module (gnu packages sphinx)
@@ -65,6 +67,34 @@ (define-module (gnu packages calendar)
   #:use-module (gnu packages xml)
   #:use-module (srfi srfi-26))
 
+(define-public python-adl-submit
+  (let ((revision "1")
+        (commit "f38c7ad161fbe6ec72ecc725edbd624f5c627ea9"))
+    (package
+     (name "python-adl-submit")
+     (version (git-version "1.0" revision commit))
+     (source
+      (origin
+       (method git-fetch)
+       (uri (git-reference
+             (url "https://framagit.org/agenda-libre/adl-submit.git")
+             (commit commit)))
+       (file-name (git-file-name name version))
+       (sha256
+        (base32 "1zi5s8xpbm253mjdlcc1j13qqz5q7s9zavk3h0m2gfgb52xy2avp"))))
+     (build-system python-build-system)
+     (inputs (list python python-pycurl))
+     (home-page "https://www.agendadulibre.org")
+     (synopsis "Submit events to the Agenda Du Libre")
+     (description "adl-submit is a tool that can be used to submit events
+to any instance of the Agenda Du Libre (a web calendar originally meant for
+free software events).  Users can set fields through the command line or
+create an XML that can be submitted with the adl-submit tool.  While the
+Agenda Du Libre web application is available in multiple languages, most of
+the events on https://www.agendadulibre.org are in French and the
+adl-submit tool is only available in French.")
+     (license license:gpl2))))
+
 (define-public date
   ;; We make the same choice as the Arch package maintainer by choosing a
   ;; recent commit to fix some bugs.

base-commit: 7d29ea6c4968de56e9edcae2632aa53d5f2e5e61
-- 
2.46.0

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.