[PATCH v7 13/31] python: add MANIFEST.in

John Snow posted 31 patches 4 years, 8 months ago
There is a newer version of this series
[PATCH v7 13/31] python: add MANIFEST.in
Posted by John Snow 4 years, 8 months ago
When creating a source or binary distribution via 'python3 setup.py
<sdist|bdist>', the VERSION and PACKAGE.rst files aren't bundled by
default. Create a MANIFEST.in file that instructs the build tools to
include these so that installation from these files won't fail.

This is required by 'tox', as well as by the tooling needed to upload
packages to PyPI.

Exclude the 'README.rst' file -- that's intended as a guidebook to our
source tree, not a file that needs to be distributed.

Signed-off-by: John Snow <jsnow@redhat.com>
---
 python/README.rst  | 2 ++
 python/MANIFEST.in | 3 +++
 2 files changed, 5 insertions(+)
 create mode 100644 python/MANIFEST.in

diff --git a/python/README.rst b/python/README.rst
index 38b0c83f321..0099646ae2f 100644
--- a/python/README.rst
+++ b/python/README.rst
@@ -33,6 +33,8 @@ Files in this directory
 -----------------------
 
 - ``qemu/`` Python package source directory.
+- ``MANIFEST.in`` is read by python setuptools, it specifies additional files
+  that should be included by a source distribution.
 - ``PACKAGE.rst`` is used as the README file that is visible on PyPI.org.
 - ``README.rst`` you are here!
 - ``VERSION`` contains the PEP-440 compliant version used to describe
diff --git a/python/MANIFEST.in b/python/MANIFEST.in
new file mode 100644
index 00000000000..7059ad28221
--- /dev/null
+++ b/python/MANIFEST.in
@@ -0,0 +1,3 @@
+include VERSION
+include PACKAGE.rst
+exclude README.rst
-- 
2.31.1


Re: [PATCH v7 13/31] python: add MANIFEST.in
Posted by Vladimir Sementsov-Ogievskiy 4 years, 8 months ago
26.05.2021 03:24, John Snow wrote:
> When creating a source or binary distribution via 'python3 setup.py
> <sdist|bdist>', the VERSION and PACKAGE.rst files aren't bundled by
> default. Create a MANIFEST.in file that instructs the build tools to
> include these so that installation from these files won't fail.
> 
> This is required by 'tox', as well as by the tooling needed to upload
> packages to PyPI.
> 
> Exclude the 'README.rst' file -- that's intended as a guidebook to our
> source tree, not a file that needs to be distributed.
> 
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
>   python/README.rst  | 2 ++
>   python/MANIFEST.in | 3 +++
>   2 files changed, 5 insertions(+)
>   create mode 100644 python/MANIFEST.in
> 
> diff --git a/python/README.rst b/python/README.rst
> index 38b0c83f321..0099646ae2f 100644
> --- a/python/README.rst
> +++ b/python/README.rst
> @@ -33,6 +33,8 @@ Files in this directory
>   -----------------------
>   
>   - ``qemu/`` Python package source directory.
> +- ``MANIFEST.in`` is read by python setuptools, it specifies additional files
> +  that should be included by a source distribution.
>   - ``PACKAGE.rst`` is used as the README file that is visible on PyPI.org.
>   - ``README.rst`` you are here!
>   - ``VERSION`` contains the PEP-440 compliant version used to describe
> diff --git a/python/MANIFEST.in b/python/MANIFEST.in
> new file mode 100644
> index 00000000000..7059ad28221
> --- /dev/null
> +++ b/python/MANIFEST.in
> @@ -0,0 +1,3 @@
> +include VERSION
> +include PACKAGE.rst
> +exclude README.rst
> 


Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>


-- 
Best regards,
Vladimir

Re: [PATCH v7 13/31] python: add MANIFEST.in
Posted by Cleber Rosa 4 years, 8 months ago
On Tue, May 25, 2021 at 08:24:36PM -0400, John Snow wrote:
> When creating a source or binary distribution via 'python3 setup.py
> <sdist|bdist>', the VERSION and PACKAGE.rst files aren't bundled by
> default. Create a MANIFEST.in file that instructs the build tools to
> include these so that installation from these files won't fail.
> 
> This is required by 'tox', as well as by the tooling needed to upload
> packages to PyPI.
> 
> Exclude the 'README.rst' file -- that's intended as a guidebook to our
> source tree, not a file that needs to be distributed.
> 
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
>  python/README.rst  | 2 ++
>  python/MANIFEST.in | 3 +++
>  2 files changed, 5 insertions(+)
>  create mode 100644 python/MANIFEST.in
>

Reviewed-by: Cleber Rosa <crosa@redhat.com>