Merge pull request #21 from joelheaps/python311-upgrade

Python 3.11 upgrade and code refactor

.gitignore

@@ -127,3 +127,9 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# Ignore config.env
+config.env
+
+# Ignore pdm local files
+.pdm-python

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.8-alpine3.17
+FROM python:3.11-alpine
 
 # Install package
 WORKDIR /code

README.md

@@ -53,12 +53,12 @@ These are the metrics this program exports, assuming the `METRICS_PREFIX` is `qb
 
 | Metric name                                         | Type     | Description      |
 | --------------------------------------------------- | -------- | ---------------- |
-| `qbittorrent_up`                                    | gauge    | Whether if the qBittorrent server is answering requests from this exporter. A `version` label with the server version is added |
-| `qbittorrent_connected`                                         | gauge    | Whether if the qBittorrent server is connected to the Bittorrent network.  |
-| `qbittorrent_firewalled`                                        | gauge    | Whether if the qBittorrent server is connected to the Bittorrent network but is behind a firewall.  |
-| `qbittorrent_dht_nodes`                                         | gauge    | Number of DHT nodes connected to |
-| `qbittorrent_dl_info_data`                                      | counter  | Data downloaded since the server started, in bytes |
-| `qbittorrent_up_info_data`                                      | counter  | Data uploaded since the server started, in bytes |
+| `qbittorrent_up`                                    | gauge    | Whether the qBittorrent server is answering requests from this exporter. A `version` label with the server version is added. |
+| `qbittorrent_connected`                                         | gauge    | Whether the qBittorrent server is connected to the Bittorrent network.  |
+| `qbittorrent_firewalled`                                        | gauge    | Whether the qBittorrent server is connected to the Bittorrent network but is behind a firewall.  |
+| `qbittorrent_dht_nodes`                                         | gauge    | Number of DHT nodes connected to. |
+| `qbittorrent_dl_info_data`                                      | counter  | Data downloaded since the server started, in bytes. |
+| `qbittorrent_up_info_data`                                      | counter  | Data uploaded since the server started, in bytes. |
 | `qbittorrent_torrents_count`                                    | gauge    | Number of torrents for each `category` and `status`. Example: `qbittorrent_torrents_count{category="movies",status="downloading"}`|
 
 ## Screenshot

config.env.example

@@ -0,0 +1,6 @@
+QBITTORRENT_HOST=localhost
+QBITTORRENT_PORT=8080
+QBITTORRENT_USER=admin
+QBITTORRENT_PASS=adminadmin
+EXPORTER_PORT=8000
+METRICS_PREFIX=qbittorrent

pyproject.toml

@@ -0,0 +1,28 @@
+[project]
+name = "prometheus-qbittorrent-exporter"
+version = "1.3.0"
+description = "Prometheus exporter for qbittorrent"
+authors = [
+    {name = "Esteban Sanchez", email = "[email protected]"},
+]
+dependencies = [
+    "prometheus-client>=0.17.1",
+    "python-json-logger>=2.0.7",
+    "qbittorrent-api>=2023.9.53",
+]
+requires-python = ">=3.11"
+readme = "README.md"
+keywords = ["prometheus", "qbittorrent"]
+license = {text = "GPL-3.0"}
+classifiers = []
+
+[project.urls]
+Homepage = "https://github.com/esanchezm/prometheus-qbittorrent-exporter"
+Downloads = "https://github.com/esanchezm/prometheus-qbittorrent-exporter/archive/1.3.0.tar.gz"
+
+[project.scripts]
+qbittorrent-exporter = "qbittorrent_exporter.exporter:main"
+
+[build-system]
+requires = ["pdm-backend"]
+build-backend = "pdm.backend"