Fix: address feedback for Fedora package

Docker.md

@@ -31,7 +31,7 @@ docker run \
   -v /run:/run:ro \
   -v /etc/timezone:/etc/timezone:ro
   -v /etc/localtime:/etc/localtime:ro
-  -v /opt/smfc/smfc.conf:/opt/smfc/smfc.conf:ro \
+  -v /etc/smfc/smfc.conf:/etc/smfc/smfc.conf:ro \
   -e SMFC_ARGS="-l 3" \
   petersulyok/smfc
 ```
@@ -58,7 +58,7 @@ services:
     volumes:
       - /dev:/dev:ro
       - /run:/run:ro
-      - /opt/smfc/smfc.conf:/opt/smfc/smfc.conf:ro
+      - /etc/smfc/smfc.conf:/etc/smfc/smfc.conf:ro
       - /etc/timezone:/etc/timezone:ro
       - /etc/localtime:/etc/localtime:ro
     restart: unless-stopped

Dockerfile

@@ -29,7 +29,7 @@ RUN <<EOT
     apk del .depends
 EOT
 
-WORKDIR /opt/smfc
+WORKDIR /etc/smfc
 ADD --chmod=755 src/smfc.py smfc.py
 
-CMD /opt/smfc/smfc.py -c /opt/smfc/smfc.conf $SMFC_ARGS
+CMD /usr/bin/smfc -c /etc/smfc/smfc.conf $SMFC_ARGS

README.md

@@ -30,11 +30,12 @@ You can also run `smfc` in docker, see more details in [Docker.md](Docker.md).
  1. Set up the IPMI threshold values for your fans (see script `ipmi/set_ipmi_threshold.sh`). 
  2. Optional: enable advanced power management features for your CPU and SATA hard disks for lower power consumption, heat generation and fan noise. 
  3. Load kernel modules (`coretemp/k10temp` and `drivetemp`).
- 4. Install the service with running the script `install.sh`.
- 5. Edit the configuration file `/opt/smfc/smfc.conf` and command line options in `/etc/default/smfc`.
- 6. Start the `systemd` service
- 7. Check results in system log
- 8. Leave a feedback in [issue #19](https://github.com/petersulyok/smfc/issues/19)
+ 4. Add distro specific repository for smfc.
+ 5. Install the service using your package manager.
+ 6. Edit the configuration file `/etc/smfc/smfc.conf` and command line options in `/etc/default/smfc`.
+ 7. Start the `systemd` service
+ 8. Check results in system log
+ 9. Leave a feedback in [issue #19](https://github.com/petersulyok/smfc/issues/19)
 
 ## Details
 ### 1. How does it work?
@@ -275,13 +276,13 @@ For the installation you need a root user. The default installation script `inst
 |----------------|-----------------------|---------------------------------|
 | `smsc.service` | `/etc/systemd/system` | systemd service definition file |
 | `smsc`         | `/etc/default`        | service command line options    |
-| `smsc.py`      | `/opt/smfc`           | service (python program)        |
-| `smsc.conf`    | `/opt/smfc`           | service configuration file      |
+| `smsc.py`      | `/etc/smfc`           | service (python program)        |
+| `smsc.conf`    | `/etc/smfc`           | service configuration file      |
 
 but you can use freely any other folders too. The service has the following command line options:
 
-	root@home:~/opt/smfc# ./smfc.py --help
-	usage: smfc.py [-h] [-c CONFIG_FILE] [-v] [-l {0,1,2,3,4}] [-o {0,1,2}]
+	root@home:~/etc/smfc# smfc --help
+	usage: smfc [-h] [-c CONFIG_FILE] [-v] [-l {0,1,2,3,4}] [-o {0,1,2}]
 	
 	optional arguments:
   		-h, --help      show this help message and exit
@@ -293,7 +294,7 @@ but you can use freely any other folders too. The service has the following comm
 You may configure logging output and logging level here and these options can be specified in `/etc/default/smfc`in a persistent way.
 
 ### 11. Configuration file
-Edit `/opt/smfc/smfc.conf` and specify your configuration parameters here:
+Edit `/etc/smfc/smfc.conf` and specify your configuration parameters here:
 
 	#  
 	#   smfc.conf  
@@ -420,21 +421,20 @@ This `systemd` service can be started and stopped in the standard way. Do not fo
 	● smfc.service - Super Micro Fan Control
 	     Loaded: loaded (/etc/systemd/system/smfc.service; enabled; vendor preset: enabled)
 	     Active: active (running) since Fri 2021-09-17 23:28:10 CEST; 1 day 19h ago
-	   Main PID: 1064180 (smfc.py)
+	   Main PID: 1064180 (smfc)
 	      Tasks: 1 (limit: 38371)
 	     Memory: 7.4M
 	        CPU: 41.917s
 	     CGroup: /system.slice/smfc.service
-	             └─1064180 /usr/bin/python3 /opt/smfc/smfc.py -c /opt/smfc/smfc.conf -l 2
+	             └─1064180 /usr/bin/python3 /usr/bin/smfc -c /etc/smfc/smfc.conf -l 2
 
 	Sep 19 17:12:39 home smfc.service[1064180]: CPU zone: new level > 39.0C > [T:40.0C/L:61%]
 	Sep 19 17:12:42 home smfc.service[1064180]: CPU zone: new level > 33.0C > [T:35.0C/L:48%]
 	Sep 19 17:48:14 home smfc.service[1064180]: CPU zone: new level > 38.0C > [T:40.0C/L:61%]
 
-If you are testing your configuration, you can start `smfc.py` directly in a terminal. Logging to the standard output and debug log level are useful in this case:
+If you are testing your configuration, you can start `smfc` directly in a terminal. Logging to the standard output and debug log level are useful in this case:
 
-	cd /opt
-	sudo smfc.py -o 0 -l 3
+	sudo smfc -o 0 -l 3
 
 ### 13. Checking result and monitoring logs
 All messages will be logged to the specific output and the specific level.

docker/docker-compose.yaml

@@ -12,7 +12,7 @@ services:
     volumes:
       - /dev:/dev:ro
       - /run:/run:ro
-      - /opt/smfc/smfc.conf:/opt/smfc/smfc.conf:ro
+      - /etc/smfc/smfc.conf:/etc/smfc/smfc.conf:ro
       - /etc/timezone:/etc/timezone:ro
       - /etc/localtime:/etc/localtime:ro
     restart: unless-stopped

docker/docker-start.sh

@@ -14,6 +14,6 @@ docker run \
     -v /run:/run:ro \
     -v /etc/timezone:/etc/timezone:ro \
     -v /etc/localtime:/etc/localtime:ro \
-    -v /opt/smfc/smfc.conf:/opt/smfc/smfc.conf:ro \
+    -v /etc/smfc/smfc.conf:/etc/smfc/smfc.conf:ro \
     -e SMFC_ARGS="-l 3" \
     petersulyok/smfc

pyproject.toml

@@ -1,6 +1,49 @@
+[build-system]
+requires = ["setuptools", "pytest"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "smfc"
+description = "Super Micro Fan Control for Linux"
+readme = "README.md"
+version = "3.5.0"
+authors = [
+    { name = "Peter Sulyok", email = "[email protected]" }
+]
+requires-python = ">=3.8"
+keywords = ["supermicro", "linux"]
+license = {file = "LICENSE"}
+dependencies = []
+classifiers = [
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: POSIX :: Linux",
+    "Topic :: System :: Hardware",
+    "Development Status :: 5 - Production/Stable"
+]
+
+[project.urls]
+Homepage = "https://github.com/petersulyok/smfc"
+Changelog = "https://github.com/simonw/demo-package/releases"
+Issues = "https://github.com/petersulyok/smfc/issues"
+
+[project.optional-dependencies]
+test = [
+    "pytest",
+]
+
+[project.scripts]
+smfc = "smfc.app:main"
+
+[tool.setuptools]
+packages = ["smfc"]
+
 # pytest options
 [tool.pytest.ini_options]
-pythonpath = "src"
 filterwarnings = [ "default", "ignore::pytest.PytestCollectionWarning"]
 
 # flake8 options

src/smfc → resources/smfc

@@ -3,4 +3,4 @@
 #
 
 # Startup options for the service
-OPTIONS="-c /opt/smfc/smfc.conf -l 3"
+OPTIONS="-c /etc/smfc/smfc.conf -l 3"

setup.cfg

@@ -0,0 +1,11 @@
+[metadata]
+name = smfc
+version = 3.5.0
+
+[options]
+packages =
+    smfc
+
+[options.entry_points]
+console_scripts =
+    cli-name = smfc.app:main

setup.py

@@ -0,0 +1,12 @@
+from setuptools import setup
+
+setup(
+    name='smfc',
+    version='3.5.0',
+    packages=['smfc'],
+    entry_points={
+        'console_scripts': [
+            'smfc = smfc.app:main',
+        ]
+    }
+)

smfc.spec

@@ -9,49 +9,63 @@ Release: 1%{?dist}
 Summary: Super Micro Fan Control
 
 License: GPL-3.0-or-later
-URL:	 %{forgeurl}
+URL:     %{forgeurl}
 Source:  %{forgesource}
 
-Requires: systemd
-Requires: python3 >= 3.7
-Requires: bash
-Requires: ipmitool
+Requires:   ipmitool
 Recommends: smartmontools
 Recommends: hddtemp
 
-BuildRequires: systemd
+BuildRequires: python3-devel
 BuildRequires: systemd-rpm-macros
 BuildArch:     noarch
 
-%description
-systemd service to control fans in CPU and HD zones with the help of IPMI on Super Micro X10-X13 (and some X9) motherboards.
+%global _description %{expand:
+systemd service to control fans in CPU and HD zones with the help of IPMI on
+Super Micro X10-X13 (and some X9) motherboards.}
+
+%description %_description
+
+%package -n python3-smfc
+Summary: python module for Super Micro Fan Control
+
+%global _python_module_description %{expand:
+python module for Super Micro Fan Control.}
+
+%description -n python3-smfc %_python_module_description
 
 %prep
 %forgesetup
 
-%build
-# not needed, just copying files
+%generate_buildrequires -n python3-smfc
+%pyproject_buildrequires
+
+%build -n python3-smfc
+%pyproject_wheel
 
 %install
-mkdir -p %{buildroot}/opt/smfc
-install -m 755 src/smfc.py %{buildroot}/opt/smfc/smfc.py
-install -m 644 src/smfc.conf %{buildroot}/opt/smfc/smfc.conf
-mkdir -p %{buildroot}/%{_sysconfdir}/default
-install -m 644 src/smfc %{buildroot}/%{_sysconfdir}/default/smfc
-mkdir -p %{buildroot}/%{_unitdir}
-install -m 644 src/smfc.service %{buildroot}/%{_unitdir}/smfc.service
-mkdir -p %{buildroot}/%{_presetdir}
-install -m 644 src/smfc.preset %{buildroot}/%{_presetdir}/90-smfc.preset
-
-%check
-# not needed, just copying files
+%pyproject_install
+%pyproject_save_files smfc
+install -Dm 644 resources/smfc.conf %{buildroot}%{_sysconfdir}/smfc/smfc.conf
+install -Dm 644 resources/smfc %{buildroot}%{_sysconfdir}/default/smfc
+install -Dm 644 systemd/smfc.service %{buildroot}%{_unitdir}/smfc.service
+install -Dm 644 systemd/smfc.preset %{buildroot}%{_presetdir}/90-smfc.preset
+
+%check -n python3-smfc
+%pytest
 
 %files
-/opt/smfc/smfc.py
-%config(noreplace) /opt/smfc/smfc.conf
-%config(noreplace) /etc/default/smfc
-/usr/lib/systemd/system/smfc.service
-/usr/lib/systemd/system-preset/90-smfc.preset
+%{_bindir}/smfc
+%config(noreplace) %{_sysconfdir}/smfc/smfc.conf
+%config(noreplace) %{_sysconfdir}/default/smfc
+%{_unitdir}/smfc.service
+%{_presetdir}/90-smfc.preset
+%doc README.md
+%license LICENSE
+
+%files -n python3-smfc
+%{python3_sitelib}/smfc/
+%{python3_sitelib}/smfc-%{version}.dist-info/
 %doc README.md
 %license LICENSE
 
@@ -65,6 +79,3 @@ install -m 644 src/smfc.preset %{buildroot}/%{_presetdir}/90-smfc.preset
 %systemd_postun_with_restart smfc.service
 
 %changelog
-* Wed Apr 03 2024 Ewout van Mansom <[email protected]> 3.5.0-1
-- new package built with tito
-

smfc/__init__.py

@@ -0,0 +1,5 @@
+from .logger import Log
+from .bmc import Ipmi
+from .fans import FanController
+from .zones import CpuZone, HdZone
+from .daemon import Service

smfc/app.py

@@ -0,0 +1,10 @@
+#!/usr/bin/python3
+#
+#   smfc (C) 2020-2024, Peter Sulyok
+#   IPMI fan controller for Super Micro X10/X11 motherboards.
+#
+from .daemon import Service
+
+def main() -> None:
+    service = Service()
+    service.run()