From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Fam Zheng" <fam@euphon.net>, "Kevin Wolf" <kwolf@redhat.com>,
"Thomas Huth" <thuth@redhat.com>,
"Beraldo Leal" <bleal@redhat.com>,
qemu-block@nongnu.org, "Alex Bennée" <alex.bennee@linaro.org>,
"Philippe Mathieu-Daudé" <philmd@redhat.com>,
"Wainer dos Santos Moschetta" <wainersm@redhat.com>,
"Max Reitz" <mreitz@redhat.com>,
"Willian Rampazzo" <wrampazz@redhat.com>,
"Cleber Rosa" <crosa@redhat.com>, "John Snow" <jsnow@redhat.com>,
"Eduardo Habkost" <ehabkost@redhat.com>
Subject: [PATCH v5 22/25] python: add Makefile for some common tasks
Date: Thu, 18 Feb 2021 14:27:30 -0500 [thread overview]
Message-ID: <20210218192733.370968-23-jsnow@redhat.com> (raw)
In-Reply-To: <20210218192733.370968-1-jsnow@redhat.com>
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.
make clean: delete miscellaneous build 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>
---
python/Makefile | 37 +++++++++++++++++++++++++++++++++++++
1 file changed, 37 insertions(+)
create mode 100644 python/Makefile
diff --git a/python/Makefile b/python/Makefile
new file mode 100644
index 00000000000..47940846400
--- /dev/null
+++ b/python/Makefile
@@ -0,0 +1,37 @@
+.PHONY: help venv venv-check check clean distclean
+
+help:
+ @echo "python packaging help:"
+ @echo ""
+ @echo "make venv: Create pipenv's virtual environment."
+ @echo " NOTE: Requires Python 3.6 and pipenv."
+ @echo " Will download packages from PyPI."
+ @echo " Hint: (On Fedora): 'sudo dnf install python36 pipenv'"
+ @echo ""
+ @echo "make venv-check: run linters using pipenv's virtual environment."
+ @echo " Hint: If you don't know which test to run, run this one!"
+ @echo ""
+ @echo "make check: run linters using the current environment."
+ @echo " Hint: Install deps with: 'pip install \".[devel]\"'"
+ @echo ""
+ @echo "make clean: remove build output."
+ @echo ""
+ @echo "make distclean: remove venv files, qemu package forwarder, and"
+ @echo " everything from 'make clean'."
+
+venv: .venv
+.venv: Pipfile.lock
+ @PIPENV_VENV_IN_PROJECT=1 pipenv sync --dev --keep-outdated
+ @touch .venv
+
+venv-check: venv
+ @pipenv run make check
+
+check:
+ @pytest
+
+clean:
+ rm -rf build/ dist/
+
+distclean: clean
+ rm -rf qemu.egg-info/ .venv
--
2.29.2
next prev parent reply other threads:[~2021-02-18 20:00 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-18 19:27 [PATCH v5 00/25] python: create installable package John Snow
2021-02-18 19:27 ` [PATCH v5 01/25] python/console_socket: avoid one-letter variable John Snow
2021-02-18 19:27 ` [PATCH v5 02/25] iotests/297: add --namespace-packages to mypy arguments John Snow
2021-02-18 19:27 ` [PATCH v5 03/25] python: create qemu packages John Snow
2021-02-18 19:27 ` [PATCH v5 04/25] python: create utils sub-package John Snow
2021-02-18 19:27 ` [PATCH v5 05/25] python: add qemu package installer John Snow
2021-02-18 19:27 ` [PATCH v5 06/25] python: add VERSION file John Snow
2021-02-18 19:27 ` [PATCH v5 07/25] python: add directory structure README.rst files John Snow
2021-02-18 19:27 ` [PATCH v5 08/25] python: Add pipenv support John Snow
2021-02-18 19:27 ` [PATCH v5 09/25] python: add pylint import exceptions John Snow
2021-02-18 19:27 ` [PATCH v5 10/25] python: move pylintrc into setup.cfg John Snow
2021-02-18 19:27 ` [PATCH v5 11/25] python: add pylint to pipenv John Snow
2021-02-18 19:27 ` [PATCH v5 12/25] python: move flake8 config to setup.cfg John Snow
2021-02-18 19:27 ` [PATCH v5 13/25] python: add excluded dirs to flake8 config John Snow
2021-02-18 19:27 ` [PATCH v5 14/25] python: Add flake8 to pipenv John Snow
2021-02-18 19:27 ` [PATCH v5 15/25] python: move mypy.ini into setup.cfg John Snow
2021-02-18 19:27 ` [PATCH v5 16/25] python: add mypy to pipenv John Snow
2021-02-18 19:27 ` [PATCH v5 17/25] python: move .isort.cfg into setup.cfg John Snow
2021-02-18 19:27 ` [PATCH v5 18/25] python/qemu: add isort to pipenv John Snow
2021-02-18 19:27 ` [PATCH v5 19/25] python/qemu: add qemu package itself " John Snow
2021-02-18 19:27 ` [PATCH v5 20/25] python: add devel package requirements to setuptools John Snow
2021-02-18 19:27 ` [PATCH v5 21/25] python: add pytest and tests John Snow
2021-02-18 19:27 ` John Snow [this message]
2021-02-18 19:27 ` [PATCH v5 23/25] python: add .gitignore John Snow
2021-02-18 19:27 ` [PATCH v5 24/25] gitlab: add python linters to CI John Snow
2021-02-18 19:27 ` [PATCH v5 25/25] python: add 'make develop' target John Snow
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210218192733.370968-23-jsnow@redhat.com \
--to=jsnow@redhat.com \
--cc=alex.bennee@linaro.org \
--cc=bleal@redhat.com \
--cc=crosa@redhat.com \
--cc=ehabkost@redhat.com \
--cc=fam@euphon.net \
--cc=kwolf@redhat.com \
--cc=mreitz@redhat.com \
--cc=philmd@redhat.com \
--cc=qemu-block@nongnu.org \
--cc=qemu-devel@nongnu.org \
--cc=thuth@redhat.com \
--cc=wainersm@redhat.com \
--cc=wrampazz@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).