summary refs log tree commit diff stats
path: root/python/PACKAGE.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/PACKAGE.rst
parenta4dd49d40536b7ad70ab9c2e25a7810773ca32bc (diff)
downloadfocaccia-qemu-dbe75f55669a4e2295b0dae161b8f796e6dbaded.tar.gz
focaccia-qemu-dbe75f55669a4e2295b0dae161b8f796e6dbaded.zip
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/PACKAGE.rst')
-rw-r--r--python/PACKAGE.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/python/PACKAGE.rst b/python/PACKAGE.rst
index 1bbfe1b58e..05ea7789fc 100644
--- a/python/PACKAGE.rst
+++ b/python/PACKAGE.rst
@@ -31,3 +31,7 @@ official `GitLab mirror <https://gitlab.com/qemu-project/qemu>`_.
 Please report bugs on the `QEMU issue tracker
 <https://gitlab.com/qemu-project/qemu/-/issues>`_ and tag ``@jsnow`` in
 the report.
+
+Optional packages necessary for running code quality analysis for this
+package can be installed with the optional dependency group "devel":
+``pip install qemu[devel]``.