GNU bug report logs - #51432
[PATCH 0/4] gnu: Add flask-combo-jsonapi

Previous Next

Package: guix-patches;

Reported by: david larsson <david.larsson <at> selfhosted.xyz>

Date: Wed, 27 Oct 2021 10:53:02 UTC

Severity: normal

Tags: patch

Done: Tobias Geerinckx-Rice <me <at> tobias.gr>

Bug is archived. No further changes may be made.

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 51432 in the body.
You can then email your comments to 51432 AT debbugs.gnu.org in the normal way.

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

View this report as an mbox folder, status mbox, maintainer mbox


Report forwarded to guix-patches <at> gnu.org:
bug#51432; Package guix-patches. (Wed, 27 Oct 2021 10:53:02 GMT) Full text and rfc822 format available.

Acknowledgement sent to david larsson <david.larsson <at> selfhosted.xyz>:
New bug report received and forwarded. Copy sent to guix-patches <at> gnu.org. (Wed, 27 Oct 2021 10:53:02 GMT) Full text and rfc822 format available.

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

From: david larsson <david.larsson <at> selfhosted.xyz>
To: guix-patches <at> gnu.org
Subject: [PATCH 0/4] gnu: Add flask-combo-jsonapi
Date: Wed, 27 Oct 2021 12:52:32 +0200
Hi!
This patch series is to add python-flask-combo-jsonapi and necessary 
dependencies.

Best regards,
David




Information forwarded to guix-patches <at> gnu.org:
bug#51432; Package guix-patches. (Wed, 27 Oct 2021 10:58:02 GMT) Full text and rfc822 format available.

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

From: david larsson <david.larsson <at> selfhosted.xyz>
To: 51432 <at> debbugs.gnu.org
Subject: Re: [bug#51432] [PATCH 1/4] gnu: Add sqlalchemy-1.3
Date: Wed, 27 Oct 2021 12:56:38 +0200
[Message part 1 (text/plain, inline)]
On 2021-10-27 12:52, david larsson wrote:
> Hi!
> This patch series is to add python-flask-combo-jsonapi and necessary
> dependencies.
> 
> Best regards,
> David

Adds sqlalchemy-1.3 because flask-combo-jsonapi requires less than 
version 1.4.
[0001-gnu-Add-sqlalchemy-1.3.patch (text/x-diff, attachment)]

Information forwarded to guix-patches <at> gnu.org:
bug#51432; Package guix-patches. (Wed, 27 Oct 2021 11:00:02 GMT) Full text and rfc822 format available.

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

From: david larsson <david.larsson <at> selfhosted.xyz>
To: 51432 <at> debbugs.gnu.org
Subject: Re: [bug#51432] [PATCH 2/4] gnu: Add marshmallow 3.2
Date: Wed, 27 Oct 2021 12:59:36 +0200
[Message part 1 (text/plain, inline)]
On 2021-10-27 12:52, david larsson wrote:
> Hi!
> This patch series is to add python-flask-combo-jsonapi and necessary
> dependencies.
> 
> Best regards,
> David

flask-combo-jsonapi needs a marshmallow that is at version 3.2.
[0002-gnu-Add-marshmallow-3.2.patch (text/x-diff, attachment)]

Information forwarded to guix-patches <at> gnu.org:
bug#51432; Package guix-patches. (Wed, 27 Oct 2021 11:02:01 GMT) Full text and rfc822 format available.

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

From: david larsson <david.larsson <at> selfhosted.xyz>
To: 51432 <at> debbugs.gnu.org
Cc: Guix-patches <guix-patches-bounces+david.larsson=selfhosted.xyz <at> gnu.org>
Subject: Re: [bug#51432] [PATCH 3/4] gnu: Add marshmallow-jsonapi
Date: Wed, 27 Oct 2021 13:01:24 +0200
[Message part 1 (text/plain, inline)]
On 2021-10-27 12:52, david larsson wrote:
> Hi!
> This patch series is to add python-flask-combo-jsonapi and necessary
> dependencies.
> 
> Best regards,
> David

Adds the dependency on marshmallow-jsonapi.
[0003-gnu-Add-marshmallow-jsonapi.patch (text/x-diff, attachment)]

Information forwarded to guix-patches <at> gnu.org:
bug#51432; Package guix-patches. (Wed, 27 Oct 2021 11:03:02 GMT) Full text and rfc822 format available.

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

From: david larsson <david.larsson <at> selfhosted.xyz>
To: 51432 <at> debbugs.gnu.org
Cc: Guix-patches <guix-patches-bounces+david.larsson=selfhosted.xyz <at> gnu.org>
Subject: Re: [bug#51432] [PATCH 4/4] gnu: Add flask-combo-jsonapi
Date: Wed, 27 Oct 2021 13:02:23 +0200
[Message part 1 (text/plain, inline)]
On 2021-10-27 12:52, david larsson wrote:
> Hi!
> This patch series is to add python-flask-combo-jsonapi and necessary
> dependencies.
> 
> Best regards,
> David

Finally, adds the package flask-combo-jsonapi.
[0004-gnu-Add-flask-combo-jsonapi.patch (text/x-diff, attachment)]

Information forwarded to guix-patches <at> gnu.org:
bug#51432; Package guix-patches. (Wed, 27 Oct 2021 18:45:02 GMT) Full text and rfc822 format available.

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

From: david larsson <david.larsson <at> selfhosted.xyz>
To: 51432 <at> debbugs.gnu.org
Subject: Re: [bug#51432] [PATCH 4/4] gnu: Add flask-combo-jsonapi
Date: Wed, 27 Oct 2021 20:44:16 +0200
[Message part 1 (text/plain, inline)]
On 2021-10-27 13:02, david larsson wrote:
> On 2021-10-27 12:52, david larsson wrote:
>> Hi!
>> This patch series is to add python-flask-combo-jsonapi and necessary
>> dependencies.
>> 
>> Best regards,
>> David
> 
> Finally, adds the package flask-combo-jsonapi.

Version 2 of this patch, fixing the synopsis according to coding 
standards max 80 chars.
[0004-gnu-Add-flask-combo-jsonapi.patch (text/x-diff, attachment)]

Information forwarded to guix-patches <at> gnu.org:
bug#51432; Package guix-patches. (Wed, 03 Nov 2021 17:47:01 GMT) Full text and rfc822 format available.

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

From: Tobias Geerinckx-Rice <me <at> tobias.gr>
To: david larsson <david.larsson <at> selfhosted.xyz>
Cc: Guix-patches <guix-patches-bounces+david.larsson=selfhosted.xyz <at> gnu.org>,
 guix-patches <at> gnu.org, 51432 <at> debbugs.gnu.org
Subject: Re: [bug#51432] [PATCH 3/4] gnu: Add marshmallow-jsonapi
Date: Wed, 03 Nov 2021 14:34:19 +0100
[Message part 1 (text/plain, inline)]
David,

> +        (base32
> +         "1d9pxcgmln4gls99vwj1h24qv0lz7fb2jqmqrsiv1pid1snc125x"))))
[…]
> +    (home-page
> +     "https://github.com/marshmallow-code/marshmallow-jsonapi")
> +    (synopsis
> +     "JSON API 1.0 (https://jsonapi.org) formatting with 
> marshmallow")

Nitpick: none of these need to be on separate lines (after 
removing the URL from the description).

Guix synopses and descriptions support (a comfortable subset of) 
Texinfo.  You can include hyperlinks in Texinfo with

 @uref{https://your.url/here, optional description}

For subjective reasons I decided to keep only the URL in the 
description.

> +    (description
> +     "JSON API 1.0 (https://jsonapi.org) formatting with 
> marshmallow")

Descriptions should consist of full sentences.  A single line is 
way too short.  Upstream has a fine description that fits our 
standards, so I adapted it:

+    (description
+     "The marshmallow-jsonapi package provides a simple way to 
produce
+@uref{https://jsonapi.org, JSON:API}-compliant data in any Python 
Web framework.
+It includes optional utilities to integrate with Flask.")

> +    (license license:expat))) ; MIT license

No need for this comment.

Thanks!

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

Information forwarded to guix-patches <at> gnu.org:
bug#51432; Package guix-patches. (Wed, 03 Nov 2021 17:47:01 GMT) Full text and rfc822 format available.

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

From: Tobias Geerinckx-Rice <me <at> tobias.gr>
To: david larsson <david.larsson <at> selfhosted.xyz>
Cc: 51432 <at> debbugs.gnu.org
Subject: Re: [bug#51432] [PATCH 2/4] gnu: Add marshmallow 3.2
Date: Wed, 03 Nov 2021 15:30:57 +0100
[Message part 1 (text/plain, inline)]
David,

Let's inherit the current python-marshmallow to avoid all this 
duplication:

+(define-public python-marshmallow-3.2
+  (package
+    (inherit python-marshmallow)
+    (version "3.2.1")
+    (source
+     (origin
+       (method url-fetch)
+       (uri (pypi-uri "marshmallow" version))
+       (sha256
+        (base32 
"1w18klwj0z9bqxj252qpj1hz8l46nl27sbc89rkajc7mln73wbws"))))))

If you're thinking, ‘wait a minute, what happens to my precious 
3.2 package if someone updates 3.9 in a weird way?’, well, you're 
right.  There are trade-offs to both.

Kind regards,

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

Information forwarded to guix-patches <at> gnu.org:
bug#51432; Package guix-patches. (Wed, 03 Nov 2021 17:47:02 GMT) Full text and rfc822 format available.

Reply sent to Tobias Geerinckx-Rice <me <at> tobias.gr>:
You have taken responsibility. (Wed, 03 Nov 2021 17:47:02 GMT) Full text and rfc822 format available.

Notification sent to david larsson <david.larsson <at> selfhosted.xyz>:
bug acknowledged by developer. (Wed, 03 Nov 2021 17:47:03 GMT) Full text and rfc822 format available.

Message #34 received at 51432-done <at> debbugs.gnu.org (full text, mbox):

From: Tobias Geerinckx-Rice <me <at> tobias.gr>
To: david larsson <david.larsson <at> selfhosted.xyz>
Cc: 51432-done <at> debbugs.gnu.org
Subject: Re: [bug#51432] [PATCH 1/4] gnu: Add sqlalchemy-1.3
Date: Wed, 03 Nov 2021 14:27:41 +0100
[Message part 1 (text/plain, inline)]
David,

Thanks!  I've pushed this series as 
52a7fba8fc78763967c15781ea9b9176d3b4cc26 et al.

> Subject: [PATCH 1/4] gnu: Add sqlalchemy-1.3.

Use the full package name here.  This applies to all patches in 
this series AFAICT.

> +    ;; (propagated-inputs
> +    ;;  `(("python-greenlet" ,python-greenlet)))

Why is this commented out?  Please add a comment in such cases (if 
you've verified that all dependents still work without it, or that 
it was added after 1.3.20).

Great news!  This whole package can instead be written as:

(define-public python-sqlalchemy-1.3
 (package
   (inherit python-sqlalchemy)
   (version "1.3.20")
   (source
    (origin
     (method url-fetch)
     (uri (pypi-uri "SQLAlchemy" version))
     (sha256
      (base32 "18b9am7bsqc4nj3d2h5r93i002apczxfvpfpcqbd6f0385zmrwnj"))))
   (propagated-inputs '())))

Kind regards,

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

Information forwarded to guix-patches <at> gnu.org:
bug#51432; Package guix-patches. (Wed, 03 Nov 2021 17:48:01 GMT) Full text and rfc822 format available.

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

From: Tobias Geerinckx-Rice <me <at> tobias.gr>
To: david larsson <david.larsson <at> selfhosted.xyz>
Cc: guix-patches <at> gnu.org, 51432 <at> debbugs.gnu.org
Subject: Re: [bug#51432] [PATCH 4/4] gnu: Add flask-combo-jsonapi
Date: Wed, 03 Nov 2021 14:46:59 +0100
[Message part 1 (text/plain, inline)]
David,

> Version 2 of this patch, fixing the synopsis according to coding
> standards max 80 chars.

Thanks!  Be sure to run ‘guix lint’ on each package as well.

> +       (method url-fetch)
> +       (uri (string-append
> +             "https://github.com/AdCombo/flask-combo-jsonapi/archive/"
> +             version ".tar.gz"))

GitHub /archive/ have proven unstable in the past: they can be 
regenerated at GitHub's discretion and no longer match our hash.

I replaced url-fetch with git-fetch.

> +    (native-inputs `(("python-coverage" ,python-coverage)

This alignment is at least inconsistent with propagated-inputs 
above.  Furthermore I simply dislike it, so I changed it :-)

> +    (native-inputs
> +     `(("python-coverage" ,python-coverage)

I shortened the description a smidge and rewrote the following 
sentence fragment:

> +    (description
> +     "Flask extension to create REST web api according to 
> JSON:API 1.0
> +specification with Flask, Marshmallow and data provider of your
> +choice (SQLAlchemy, MongoDB, ...)")

as:

+    (description
+     "Flask-COMBO-JSONAPI is a Python Flask extension for 
building REST Web APIs
+compliant with the @uref{https://jsonapi.org, JSON:API 1.0} 
specification.
+
+It tries to combine the power of Flask-Restless with the 
flexibility of
+Flask-RESTful to quickly build APIs that fit the complexity of 
existing
+real-life projects with legacy data and diverse storage 
providers.")

I deliberately removed the reference to MongoDB because it's not 
of any particular significance and non-free.  I also removed 
several more gratuitous references in Guix proper.

Kind regards,

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

Information forwarded to guix-patches <at> gnu.org:
bug#51432; Package guix-patches. (Wed, 03 Nov 2021 17:48:02 GMT) Full text and rfc822 format available.

bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Thu, 02 Dec 2021 12:24:04 GMT) Full text and rfc822 format available.

This bug report was last modified 3 years and 258 days ago.

Previous Next


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