aboutsummaryrefslogtreecommitdiff
path: root/python/README.rst
diff options
context:
space:
mode:
authorJohn Snow <jsnow@redhat.com>2021-05-27 17:17:10 -0400
committerJohn Snow <jsnow@redhat.com>2021-06-01 16:21:21 -0400
commitdbe75f55669a4e2295b0dae161b8f796e6dbaded (patch)
treeec12ac59b9c4fdd77ad02dacf4d9ab7b905b6db4 /python/README.rst
parenta4dd49d40536b7ad70ab9c2e25a7810773ca32bc (diff)
python: add devel package requirements to setuptools
setuptools doesn't have a formal understanding of development requires, but it has an optional feataures section. Fine; add a "devel" feature and add the requirements to it. To avoid duplication, we can modify pipenv to install qemu[devel] instead. This enables us to run invocations like "pip install -e .[devel]" and test the package on bleeding-edge packages beyond those specified in Pipfile.lock. Importantly, this also allows us to install the qemu development packages in a non-networked mode: `pip3 install --no-index -e .[devel]` will now fail if the proper development dependencies are not already met. This can be useful for automated build scripts where fetching network packages may be undesirable. Signed-off-by: John Snow <jsnow@redhat.com> Reviewed-by: Cleber Rosa <crosa@redhat.com> Message-id: 20210527211715.394144-27-jsnow@redhat.com Signed-off-by: John Snow <jsnow@redhat.com>
Diffstat (limited to 'python/README.rst')
-rw-r--r--python/README.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/python/README.rst b/python/README.rst
index bf9bbca979..954870973d 100644
--- a/python/README.rst
+++ b/python/README.rst
@@ -24,6 +24,10 @@ which installs a version of the package that installs a forwarder
pointing to these files, such that the package always reflects the
latest version in your git tree.
+Installing ".[devel]" instead of "." will additionally pull in required
+packages for testing this package. They are not runtime requirements,
+and are not needed to simply use these libraries.
+
See `Installing packages using pip and virtual environments
<https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/>`_
for more information.