pm: cpupower: Add install and uninstall options to bindings makefile

Commit Message

John B. Wyatt IV Dec. 19, 2024, 1:26 a.m. UTC

Installs the .so and .py files generated by SWIG to system's site packages
directory. This allows the Python bindings to be used system wide. This
commit also includes documentation on setting up and installing the Python
bindings.

Signed-off-by: "John B. Wyatt IV" <[e-mail]>
Signed-off-by: "John B. Wyatt IV" <[e-mail]>
---
 tools/power/cpupower/bindings/python/Makefile | 10 ++++++++
 tools/power/cpupower/bindings/python/README   | 25 +++++++++++++++++++
 2 files changed, 35 insertions(+)

Comments

Shuah Khan Dec. 20, 2024, 4:36 p.m. UTC | #1

On 12/18/24 18:26, John B. Wyatt IV wrote:
> Installs the .so and .py files generated by SWIG to system's site packages
> directory. This allows the Python bindings to be used system wide. This
> commit also includes documentation on setting up and installing the Python
> bindings.
> 
> Signed-off-by: "John B. Wyatt IV" <[e-mail]>
> Signed-off-by: "John B. Wyatt IV" <[e-mail]>
> ---
>   tools/power/cpupower/bindings/python/Makefile | 10 ++++++++
>   tools/power/cpupower/bindings/python/README   | 25 +++++++++++++++++++
>   2 files changed, 35 insertions(+)
> 

Thank you. This patch is now in

https://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux.git/log/?h=cpupower

I will include this in pull request to Rafael in early January.

thanks,
-- Shuah

Patch

diff --git a/tools/power/cpupower/bindings/python/Makefile b/tools/power/cpupower/bindings/python/Makefile
index e1ebb1d60cd4..741f21477432 100644
--- a/tools/power/cpupower/bindings/python/Makefile
+++ b/tools/power/cpupower/bindings/python/Makefile
@@ -11,6 +11,7 @@  HAVE_PYCONFIG := $(shell if which python-config >/dev/null 2>&1; then echo 1; el
 LIB_DIR := ../../lib
 PY_INCLUDE = $(firstword $(shell python-config --includes))
 OBJECTS_LIB = $(wildcard $(LIB_DIR)/*.o)
+INSTALL_DIR = $(shell python3 -c "import site; print(site.getsitepackages()[0])")
 
 all: _raw_pylibcpupower.so
 
@@ -28,6 +29,15 @@  else ifeq ($(HAVE_PYCONFIG),0)
 endif
 	swig -python raw_pylibcpupower.swg
 
+# Only installs the Python bindings
+install: _raw_pylibcpupower.so
+	install -D _raw_pylibcpupower.so $(INSTALL_DIR)/_raw_pylibcpupower.so
+	install -D raw_pylibcpupower.py $(INSTALL_DIR)/raw_pylibcpupower.py
+
+uninstall:
+	rm -f $(INSTALL_DIR)/_raw_pylibcpupower.so
+	rm -f $(INSTALL_DIR)/raw_pylibcpupower.py
+
 # Will only clean the bindings folder; will not clean the actual cpupower folder
 clean:
 	rm -f raw_pylibcpupower.py raw_pylibcpupower_wrap.c raw_pylibcpupower_wrap.o _raw_pylibcpupower.so
diff --git a/tools/power/cpupower/bindings/python/README b/tools/power/cpupower/bindings/python/README
index 0a4bb2581e8a..952e2e02fd32 100644
--- a/tools/power/cpupower/bindings/python/README
+++ b/tools/power/cpupower/bindings/python/README
@@ -48,6 +48,31 @@  To run the test script:
 $ python test_raw_pylibcpupower.py
 
 
+developing/using the bindings directly
+--------------------------------------
+
+You need to add the Python bindings directory to your $PYTHONPATH.
+
+You would set the path in the Bash terminal or in the Bash profile:
+
+PYTHONPATH=~/linux/tools/power/cpupower/bindings/python:$PYTHONPATH
+
+This allows you to set a specific repo of the bindings to use.
+
+
+installing/uninstalling
+-----------------------
+
+Python uses a system specific site-packages folder to look up modules to import
+by default. You do not need to install cpupower to use the SWIG bindings.
+
+You can install and uninstall the bindings to the site-packages with:
+
+sudo make install
+
+sudo make uninstall
+
+
 credits
 -------