yfinance-exporter 1.0.0__tar.gz

yfinance_exporter-1.0.0/PKG-INFO

@@ -0,0 +1,61 @@
+Metadata-Version: 2.1
+Name: yfinance-exporter
+Version: 1.0.0
+Summary: 
+Author: François Schmidts
+Author-email: francois@schmidts.fr
+Requires-Python: >=3.12,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: prometheus-client (>=0.21.1,<0.22.0)
+Requires-Dist: the-conf (>=1.0.4,<2.0.0)
+Requires-Dist: yfinance (>=0.2.51,<0.3.0)
+Description-Content-Type: text/markdown
+
+[![PyPI - Version](https://img.shields.io/pypi/v/yfinance-exporter)](https://pypi.org/project/yfinance-exporter/) [![Docker Image Version](https://img.shields.io/docker/v/jaesivsm/yfinance-exporter)](https://hub.docker.com/r/jaesivsm/yfinance-exporter/tags)
+
+# YFinance Exporter
+
+
+## Metrics served
+
+
+```json
+{
+    "stocks": [
+        {"isin": "FR0000120073", "name": "AIR LIQUIDE", "ycode": "AI.PA"}
+    ]
+}
+```
+
+## Running it
+
+For the next few bits of code, we'll suppose you have a working configuration above in `~/.config/yfinance-exporter.json`.
+
+### ... with python:
+
+```shell
+pip install yfinance-exporter
+python -m yfinance_exporter
+```
+
+### ... with docker:
+
+```shell
+ docker run -v ~/.config/:/etc/yfinance-exporter/:ro -p 9100:9100 yfinance-exporter:main
+```
+
+You'll then be able retrieve some values:
+
+```shell
+curl localhost:9100/metrics
+
+# HELP yfinance_exporter
+# TYPE yfinance_exporter gauge
+yfinance_exporter{status="loop"} 1.0
+yfinance_exporter{status="loop-time"} 10.179875
+yfinance_exporter{status="ok-stock"} 45.0
+yfinance_exporter{status="ko-stock"} 2.0
+[...]
+```
+

yfinance_exporter-1.0.0/README.md

@@ -0,0 +1,46 @@
+[![PyPI - Version](https://img.shields.io/pypi/v/yfinance-exporter)](https://pypi.org/project/yfinance-exporter/) [![Docker Image Version](https://img.shields.io/docker/v/jaesivsm/yfinance-exporter)](https://hub.docker.com/r/jaesivsm/yfinance-exporter/tags)
+
+# YFinance Exporter
+
+
+## Metrics served
+
+
+```json
+{
+    "stocks": [
+        {"isin": "FR0000120073", "name": "AIR LIQUIDE", "ycode": "AI.PA"}
+    ]
+}
+```
+
+## Running it
+
+For the next few bits of code, we'll suppose you have a working configuration above in `~/.config/yfinance-exporter.json`.
+
+### ... with python:
+
+```shell
+pip install yfinance-exporter
+python -m yfinance_exporter
+```
+
+### ... with docker:
+
+```shell
+ docker run -v ~/.config/:/etc/yfinance-exporter/:ro -p 9100:9100 yfinance-exporter:main
+```
+
+You'll then be able retrieve some values:
+
+```shell
+curl localhost:9100/metrics
+
+# HELP yfinance_exporter
+# TYPE yfinance_exporter gauge
+yfinance_exporter{status="loop"} 1.0
+yfinance_exporter{status="loop-time"} 10.179875
+yfinance_exporter{status="ok-stock"} 45.0
+yfinance_exporter{status="ko-stock"} 2.0
+[...]
+```

yfinance_exporter-1.0.0/pyproject.toml

@@ -0,0 +1,31 @@
+[tool.poetry]
+name = "yfinance-exporter"
+version = "1.0.0"
+description = ""
+authors = ["François Schmidts <francois@schmidts.fr>"]
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.12"
+yfinance = "^0.2.51"
+prometheus-client = "^0.21.1"
+the-conf = "^1.0.4"
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+
+[tool.poetry.group.dev.dependencies]
+black = "^24.10.0"
+mypy = "^1.13.0"
+pycodestyle = "^2.12.1"
+flake8 = "^7.1.1"
+pylint = "^3.3.2"
+ipdb = "^0.13.13"
+types-requests = "^2.32.0.20241016"
+
+[tool.black]
+line-length = 79
+target-version = ["py312"]

yfinance_exporter-1.0.0/yfinance_exporter.py

@@ -0,0 +1,127 @@
+#!/usr/bin/env python3
+
+import logging
+
+from prometheus_client import Gauge, start_http_server
+from datetime import datetime
+import time
+from the_conf import TheConf
+from yfinance import Ticker
+
+metaconf = {
+    "source_order": ["files"],
+    "config_files": [
+        "~/.config/yfinance-exporter.json",
+        "/etc/yfinance-exporter/yfinance-exporter.json",
+    ],
+    "parameters": [
+        {
+            "type": "list",
+            "stocks": [
+                {"name": {"type": str}},
+                {"isin": {"type": str}},
+                {"ycode": {"type": str}},
+            ],
+        },
+        {
+            "loop": [
+                {"interval": {"type": int, "default": 240}},
+            ]
+        },
+        {
+            "prometheus": [
+                {"port": {"type": int, "default": 9100}},
+                {"namespace": {"type": str, "default": ""}},
+            ]
+        },
+        {"logging": [{"level": {"default": "WARNING"}}]},
+    ],
+}
+conf = TheConf(metaconf)
+logger = logging.getLogger("yfinance-exporter")
+try:
+    logger.setLevel(getattr(logging, conf.logging.level))
+    logger.addHandler(logging.StreamHandler())
+except AttributeError as error:
+    raise AttributeError(
+        f"{conf.logging.level} isn't accepted, only DEBUG, INFO, WARNING, "
+        "ERROR and FATAL are accepted"
+    ) from error
+
+YFINANCE_EXPORTER = Gauge(
+    "yfinance_exporter",
+    "",
+    ["status"],
+    namespace=conf.prometheus.namespace,
+)
+STOCK = Gauge(
+    "financial_positions",
+    "",
+    [
+        "bank",
+        "account_type",
+        "account_name",
+        "account_id",
+        "line_name",
+        "line_id",
+        "value_type",  # par-value, shares-value, gain, gain-percent, quantity
+    ],
+    namespace=conf.prometheus.namespace,
+)
+
+
+def collect(stock):
+    logger.debug("Collecting for %r", stock.name)
+    labels = [
+        stock.ycode.split(".")[1] if "." in stock.ycode else "",
+        "stocks",
+        "market",
+        "market",
+        stock.name,
+        stock.isin,
+        "par-value",
+    ]
+    ticker = Ticker(stock.ycode)
+    try:
+        value = ticker.fast_info["last_price"]
+    except KeyError:
+        value = None
+    if not isinstance(value, (int, float)):
+        try:
+            STOCK.remove(*labels)
+        except KeyError:
+            pass
+        return False
+    STOCK.labels(*labels).set(value)
+    return True
+
+
+def main():
+    YFINANCE_EXPORTER.labels("loop-count").set(0)
+    while True:
+        start = datetime.now()
+
+        results = {"ok-stock": 0, "ko-stock": 0}
+        for stock in conf.stocks:
+            if collect(stock):
+                results["ok-stock"] += 1
+            else:
+                results["ko-stock"] += 1
+
+        exec_interval = (datetime.now() - start).total_seconds()
+        YFINANCE_EXPORTER.labels("loop-duration-second").set(exec_interval)
+        YFINANCE_EXPORTER.labels("loop-count").inc()
+        for result, count in results.items():
+            YFINANCE_EXPORTER.labels(result).set(count)
+
+        interval = conf.loop.interval - exec_interval
+        if interval > 0:
+            time.sleep(interval)
+
+
+if __name__ == "__main__":
+    logger.info(
+        "Starting yfinance exporter with %d stocks to watch", len(conf.stocks)
+    )
+    start_http_server(conf.prometheus.port)
+    main()