diff options
| author | John Snow <jsnow@redhat.com> | 2021-05-27 17:17:12 -0400 |
|---|---|---|
| committer | John Snow <jsnow@redhat.com> | 2021-06-01 16:21:21 -0400 |
| commit | 6560379facf40e66fd8fbf4578f3d28f510167d8 (patch) | |
| tree | e5d7c62fa25fd204067e05830d603ea20d458c25 /python/PACKAGE.rst | |
| parent | 31622b2a8ac769b3cef730d3a24ed209e3861cbc (diff) | |
python: add Makefile for some common tasks
Add "make venv" to create the pipenv-managed virtual environment that
contains our explicitly pinned dependencies.
Add "make check" to run the python linters [in the host execution
environment].
Add "make venv-check" which combines the above two: create/update the
venv, then run the linters in that explicitly managed environment.
Add "make develop" which canonizes the runes needed to get both the
linting pre-requisites (the "[devel]" part), and the editable
live-install (the "-e" part) of these python libraries.
make clean: delete miscellaneous python packaging output possibly
created by pipenv, pip, or other python packaging utilities
make distclean: delete the above, the .venv, and the editable "qemu"
package forwarder (qemu.egg-info) if there is one.
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Cleber Rosa <crosa@redhat.com>
Tested-by: Cleber Rosa <crosa@redhat.com>
Message-id: 20210527211715.394144-29-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
Diffstat (limited to 'python/PACKAGE.rst')
| -rw-r--r-- | python/PACKAGE.rst | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/python/PACKAGE.rst b/python/PACKAGE.rst index 05ea7789fc..b0b86cc4c3 100644 --- a/python/PACKAGE.rst +++ b/python/PACKAGE.rst @@ -35,3 +35,9 @@ 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]``. + +``make develop`` can be used to install this package in editable mode +(to the current environment) *and* bring in testing dependencies in one +command. + +``make check`` can be used to run the available tests. |