aboutsummaryrefslogtreecommitdiff
path: root/python/README.rst
diff options
context:
space:
mode:
authorJohn Snow <jsnow@redhat.com>2021-05-27 17:16:57 -0400
committerJohn Snow <jsnow@redhat.com>2021-06-01 16:21:21 -0400
commiteae4e442caa087b2ef292a5fb6377236fa8423f2 (patch)
tree1c8a56deb1d8d251f28e1b30ab318e755110e183 /python/README.rst
parent93128815af4efcaba03a5581c959bc7f98ee2725 (diff)
python: add MANIFEST.in
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> Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com> Reviewed-by: Cleber Rosa <crosa@redhat.com> Message-id: 20210527211715.394144-14-jsnow@redhat.com Signed-off-by: John Snow <jsnow@redhat.com>
Diffstat (limited to 'python/README.rst')
-rw-r--r--python/README.rst2
1 files changed, 2 insertions, 0 deletions
diff --git a/python/README.rst b/python/README.rst
index 38b0c83f32..0099646ae2 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