[PATCH nft,v2] INSTALL: provide examples to install python bindings

[PATCH nft,v2] INSTALL: provide examples to install python bindings

[Pablo Neira Ayuso]

Provide examples to install python bindings with legacy setup.py and pip
with .toml file.

Signed-off-by: Pablo Neira Ayuso <pablo@netfilter.org>
---
v2: add Jeremy's feedback.

 INSTALL | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/INSTALL b/INSTALL
index 53021e5aafc3..6539ebdd6457 100644
--- a/INSTALL
+++ b/INSTALL
@@ -84,10 +84,14 @@ Installation instructions for nftables
  Python support
  ==============
 
- CPython bindings are available for nftables under the py/ folder.
+ CPython bindings are available for nftables under the py/ folder.  They can be
+ installed using pip:
 
- A pyproject.toml config file and legacy setup.py script are provided to install
- it.
+    python -m pip install py/
+
+ Alternatively, legacy setup.py script is also provided to install it:
+
+	python setup.py install
 
  Source code
  ===========
-- 
2.30.2

Re: [PATCH nft,v2] INSTALL: provide examples to install python bindings

[Jeremy Sowden]

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

On 2023-08-21, at 13:28:40 +0200, Pablo Neira Ayuso wrote:
> Provide examples to install python bindings with legacy setup.py and pip
> with .toml file.
> 
> Signed-off-by: Pablo Neira Ayuso <pablo@netfilter.org>
> ---
> v2: add Jeremy's feedback.
> 
>  INSTALL | 10 +++++++---
>  1 file changed, 7 insertions(+), 3 deletions(-)
> 
> diff --git a/INSTALL b/INSTALL
> index 53021e5aafc3..6539ebdd6457 100644
> --- a/INSTALL
> +++ b/INSTALL
> @@ -84,10 +84,14 @@ Installation instructions for nftables
>   Python support
>   ==============
>  
> - CPython bindings are available for nftables under the py/ folder.
> + CPython bindings are available for nftables under the py/ folder.  They can be
> + installed using pip:
>  
> - A pyproject.toml config file and legacy setup.py script are provided to install
> - it.
> +    python -m pip install py/
> +
> + Alternatively, legacy setup.py script is also provided to install it:
> +
> +	python setup.py install
>  
>   Source code
>   ===========
> -- 
> 2.30.2
> 

If you want to retain a reference to setup.py, then how about this
patch?

J.

[-- Attachment #1.2: 0001-INSTALL-provide-examples-to-install-python-bindings.patch --]
[-- Type: text/x-diff, Size: 1147 bytes --]

From 415b23098ad9d48bd6f45f3edc589abcb9aaf87a Mon Sep 17 00:00:00 2001
From: Pablo Neira Ayuso <pablo@netfilter.org>
Date: Mon, 21 Aug 2023 13:28:40 +0200
Subject: [PATCH] INSTALL: provide examples to install python bindings

Provide examples to install python bindings with legacy setup.py and pip
with .toml file.

Signed-off-by: Pablo Neira Ayuso <pablo@netfilter.org>
---
 INSTALL | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/INSTALL b/INSTALL
index 53021e5aafc3..5d45ec988c9f 100644
--- a/INSTALL
+++ b/INSTALL
@@ -84,10 +84,16 @@ Installation instructions for nftables
  Python support
  ==============
 
- CPython bindings are available for nftables under the py/ folder.
+ CPython bindings are available for nftables under the py/ folder.  They can be
+ installed using pip:
 
- A pyproject.toml config file and legacy setup.py script are provided to install
- it.
+	python -m pip install py/
+
+ A legacy setup.py script can also be used:
+
+	( cd py && python setup.py install )
+
+ However, this method is deprecated.
 
  Source code
  ===========
-- 
2.40.1


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

Re: [PATCH nft,v2] INSTALL: provide examples to install python bindings

[Pablo Neira Ayuso]

On Mon, Aug 21, 2023 at 06:55:21PM +0100, Jeremy Sowden wrote:
> On 2023-08-21, at 13:28:40 +0200, Pablo Neira Ayuso wrote:
> > Provide examples to install python bindings with legacy setup.py and pip
> > with .toml file.
> > 
> > Signed-off-by: Pablo Neira Ayuso <pablo@netfilter.org>
> > ---
> > v2: add Jeremy's feedback.
> > 
> >  INSTALL | 10 +++++++---
> >  1 file changed, 7 insertions(+), 3 deletions(-)
> > 
> > diff --git a/INSTALL b/INSTALL
> > index 53021e5aafc3..6539ebdd6457 100644
> > --- a/INSTALL
> > +++ b/INSTALL
> > @@ -84,10 +84,14 @@ Installation instructions for nftables
> >   Python support
> >   ==============
> >  
> > - CPython bindings are available for nftables under the py/ folder.
> > + CPython bindings are available for nftables under the py/ folder.  They can be
> > + installed using pip:
> >  
> > - A pyproject.toml config file and legacy setup.py script are provided to install
> > - it.
> > +    python -m pip install py/
> > +
> > + Alternatively, legacy setup.py script is also provided to install it:
> > +
> > +	python setup.py install
> >  
> >   Source code
> >   ===========
> > -- 
> > 2.30.2
> > 
> 
> If you want to retain a reference to setup.py, then how about this
> patch?

Patch is applied here:

http://git.netfilter.org/nftables/commit/?id=97c28c926096950f1646c99b85a31de309429a0c

Thanks for your feedback.