[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v5 22/25] python: add Makefile for some common tasks
From: |
John Snow |
Subject: |
[PATCH v5 22/25] python: add Makefile for some common tasks |
Date: |
Thu, 18 Feb 2021 14:27:30 -0500 |
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
- [PATCH v5 13/25] python: add excluded dirs to flake8 config, (continued)
- [PATCH v5 13/25] python: add excluded dirs to flake8 config, John Snow, 2021/02/18
- [PATCH v5 08/25] python: Add pipenv support, John Snow, 2021/02/18
- [PATCH v5 15/25] python: move mypy.ini into setup.cfg, John Snow, 2021/02/18
- [PATCH v5 16/25] python: add mypy to pipenv, John Snow, 2021/02/18
- [PATCH v5 12/25] python: move flake8 config to setup.cfg, John Snow, 2021/02/18
- [PATCH v5 17/25] python: move .isort.cfg into setup.cfg, John Snow, 2021/02/18
- [PATCH v5 18/25] python/qemu: add isort to pipenv, John Snow, 2021/02/18
- [PATCH v5 19/25] python/qemu: add qemu package itself to pipenv, John Snow, 2021/02/18
- [PATCH v5 21/25] python: add pytest and tests, John Snow, 2021/02/18
- [PATCH v5 23/25] python: add .gitignore, John Snow, 2021/02/18
- [PATCH v5 22/25] python: add Makefile for some common tasks,
John Snow <=
- [PATCH v5 24/25] gitlab: add python linters to CI, John Snow, 2021/02/18
- [PATCH v5 20/25] python: add devel package requirements to setuptools, John Snow, 2021/02/18
- [PATCH v5 25/25] python: add 'make develop' target, John Snow, 2021/02/18