promtext-cli 0.2.1.dev7__tar.gz → 0.2.1.dev9__tar.gz

{promtext_cli-0.2.1.dev7 → promtext_cli-0.2.1.dev9}/.copier-answers.yml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier.
-_commit: 0.9.16
+_commit: 0.9.21
 _src_path: https://codeberg.org/margau/copier-python-uv.git
 code_dir: promtext_cli
 container: false

{promtext_cli-0.2.1.dev7 → promtext_cli-0.2.1.dev9}/.forgejo/workflows/commitlint.yaml

@@ -11,10 +11,10 @@ jobs:
   commitlint-check:
     runs-on: docker
     container:
-      image: codeberg.org/margau/buildenv-commitlint:latest@sha256:05a8071e9a8239be1224ede0cb24b24810f7d2731ce1bd95dfcb9ae67db9adc9
+      image: codeberg.org/margau/buildenv-commitlint:latest@sha256:6dfe15b4a0602b3a8bdaa46e86a00d43f7f6e85b6b1d965649a78b9dd92dda40
 
     steps:
-      - uses: https://code.forgejo.org/actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+      - uses: https://code.forgejo.org/actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7
         with:
           fetch-depth: 0
       - name: Validate current commit (last commit) with commitlint

{promtext_cli-0.2.1.dev7 → promtext_cli-0.2.1.dev9}/.forgejo/workflows/lint.yaml

@@ -13,14 +13,14 @@ jobs:
     env:
       UV_CACHE_DIR: /tmp/.uv-cache
     container:
-      image: codeberg.org/margau/buildenv-uv:latest@sha256:41a740b95c815bda4cc70fe9325a4c6e3c00e65f1a3ec9b979468e6202391dce
+      image: codeberg.org/margau/buildenv-uv:latest@sha256:a2559f0d865dbc7d13e82990f6147bd2124129b6e6f3b4d281579834f6ab0a64
 
     steps:
-      - uses: https://code.forgejo.org/actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+      - uses: https://code.forgejo.org/actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7
         with:
           fetch-depth: 0
       - name: cache restore
-        uses: https://code.forgejo.org/actions/cache/restore@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5
+        uses: https://code.forgejo.org/actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6
         with:
           path: /tmp/.uv-cache
           key: uv-${{ hashFiles('uv.lock') }}
@@ -38,7 +38,7 @@ jobs:
       - name: Minimize uv cache
         run: uv cache prune
       - name: cache save
-        uses: https://code.forgejo.org/actions/cache/save@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5
+        uses: https://code.forgejo.org/actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6
         with:
           path: /tmp/.uv-cache
           key: uv-${{ hashFiles('uv.lock') }}

{promtext_cli-0.2.1.dev7 → promtext_cli-0.2.1.dev9}/.forgejo/workflows/publish.yaml

@@ -16,14 +16,14 @@ jobs:
     env:
       UV_CACHE_DIR: /tmp/.uv-cache
     container:
-      image: codeberg.org/margau/buildenv-uv:latest@sha256:41a740b95c815bda4cc70fe9325a4c6e3c00e65f1a3ec9b979468e6202391dce
+      image: codeberg.org/margau/buildenv-uv:latest@sha256:a2559f0d865dbc7d13e82990f6147bd2124129b6e6f3b4d281579834f6ab0a64
     
     steps:
-      - uses: https://code.forgejo.org/actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+      - uses: https://code.forgejo.org/actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7
         with:
           fetch-depth: 0
       - name: cache restore
-        uses: https://code.forgejo.org/actions/cache/restore@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5
+        uses: https://code.forgejo.org/actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6
         with:
           path: /tmp/.uv-cache
           key: uv-${{ hashFiles('uv.lock') }}
@@ -58,7 +58,7 @@ jobs:
       - name: Minimize uv cache
         run: uv cache prune
       - name: cache save
-        uses: https://code.forgejo.org/actions/cache/save@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5
+        uses: https://code.forgejo.org/actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6
         with:
           path: /tmp/.uv-cache
           key: uv-${{ hashFiles('uv.lock') }}
@@ -67,10 +67,10 @@ jobs:
     name: "Draft Release Notes"
     runs-on: docker
     container:
-      image: codeberg.org/margau/buildenv-uv:latest@sha256:41a740b95c815bda4cc70fe9325a4c6e3c00e65f1a3ec9b979468e6202391dce
+      image: codeberg.org/margau/buildenv-uv:latest@sha256:a2559f0d865dbc7d13e82990f6147bd2124129b6e6f3b4d281579834f6ab0a64
     
     steps:
-      - uses: https://code.forgejo.org/actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+      - uses: https://code.forgejo.org/actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7
         with:
           fetch-depth: 0
       - name: draft release notes

{promtext_cli-0.2.1.dev7 → promtext_cli-0.2.1.dev9}/.forgejo/workflows/test.yaml

@@ -13,14 +13,14 @@ jobs:
     env:
       UV_CACHE_DIR: /tmp/.uv-cache
     container:
-      image: codeberg.org/margau/buildenv-uv:latest@sha256:41a740b95c815bda4cc70fe9325a4c6e3c00e65f1a3ec9b979468e6202391dce
+      image: codeberg.org/margau/buildenv-uv:latest@sha256:a2559f0d865dbc7d13e82990f6147bd2124129b6e6f3b4d281579834f6ab0a64
 
     steps:
-      - uses: https://code.forgejo.org/actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6
+      - uses: https://code.forgejo.org/actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7
         with:
           fetch-depth: 0
       - name: cache restore
-        uses: https://code.forgejo.org/actions/cache/restore@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5
+        uses: https://code.forgejo.org/actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6
         with:
           path: /tmp/.uv-cache
           key: uv-${{ hashFiles('uv.lock') }}
@@ -36,7 +36,7 @@ jobs:
       - name: Minimize uv cache
         run: uv cache prune
       - name: cache save
-        uses: https://code.forgejo.org/actions/cache/save@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5
+        uses: https://code.forgejo.org/actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6
         with:
           path: /tmp/.uv-cache
           key: uv-${{ hashFiles('uv.lock') }}

{promtext_cli-0.2.1.dev7 → promtext_cli-0.2.1.dev9}/.pre-commit-config.yaml

@@ -10,7 +10,7 @@ repos:
         stages: [commit-msg]
         args: []
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.15.17
+    rev: v0.15.20
     hooks:
       # Run the linter.
       - id: ruff-check

{promtext_cli-0.2.1.dev7 → promtext_cli-0.2.1.dev9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: promtext-cli
-Version: 0.2.1.dev7
+Version: 0.2.1.dev9
 Summary: Prometheus Textfile Tooling
 Project-URL: Documentation, https://codeberg.org/margau/promtext-cli/src/branch/main#readme
 Project-URL: Issues, https://codeberg.org/margau/promtext-cli/issues
@@ -24,13 +24,12 @@ Features:
 
 ## Usage
 ```
-promtext -h
-usage: main.py [-h] [--docs DOCS] [--label KEY=VALUE] [-v] filename metric value
+usage: promtext [-h] [--docs DOCS] [--label KEY=VALUE] [-v] [filename] metric value
 
 Prometheus textfile helper
 
 positional arguments:
-  filename           Path to existing or new prometheus textfile, will be updated
+  filename           optional path to existing or new prometheus textfile (will be created or updated)
   metric             metric name (new or updated)
   value              metric value
 
@@ -41,6 +40,8 @@ options:
   -v, --verbose
 ```
 
+If the filename is missing, an file named after the metric in `/var/prometheus` (or the directory specificed in the `PROMTEXT_DIR`-ENV) will be used.
+
 ## Examples
 `tmp/backup.prom` before:
 ```

{promtext_cli-0.2.1.dev7 → promtext_cli-0.2.1.dev9}/README.md

@@ -11,13 +11,12 @@ Features:
 
 ## Usage
 ```
-promtext -h
-usage: main.py [-h] [--docs DOCS] [--label KEY=VALUE] [-v] filename metric value
+usage: promtext [-h] [--docs DOCS] [--label KEY=VALUE] [-v] [filename] metric value
 
 Prometheus textfile helper
 
 positional arguments:
-  filename           Path to existing or new prometheus textfile, will be updated
+  filename           optional path to existing or new prometheus textfile (will be created or updated)
   metric             metric name (new or updated)
   value              metric value
 
@@ -28,6 +27,8 @@ options:
   -v, --verbose
 ```
 
+If the filename is missing, an file named after the metric in `/var/prometheus` (or the directory specificed in the `PROMTEXT_DIR`-ENV) will be used.
+
 ## Examples
 `tmp/backup.prom` before:
 ```

{promtext_cli-0.2.1.dev7 → promtext_cli-0.2.1.dev9}/promtext_cli/promtext.py

@@ -2,6 +2,7 @@
 
 import argparse
 import logging
+import os
 import sys
 from pathlib import Path
 
@@ -26,8 +27,11 @@ class Promtext:
         parser = argparse.ArgumentParser(description="Prometheus textfile helper")
         parser.add_argument(
             "filename",
-            type=str,
-            help="Path to existing or new prometheus textfile, will be updated",
+            nargs="?",
+            default=None,
+            type=Path,
+            help="""optional path to existing or new prometheus textfile
+                 (will be created or updated)""",
         )
 
         # metric name, required
@@ -62,8 +66,15 @@ class Promtext:
         )
         self.args = parser.parse_args()
 
-        # processing: check if file is available, if yes, parse
-        self.textfile = Path(self.args.filename)
+    def _config(self):
+        # figure out which file name to use
+        if self.args.filename:
+            self.textfile = self.args.filename
+        else:
+            self.textfile = Path(os.getenv("PROMTEXT_DIR", "/var/prometheus")) / Path(
+                self.args.metric + ".prom"
+            )
+            self.logger.info("using default filename %s", self.textfile)
 
     def parse_file(self):
         """If possible, convert the input textfile to metrics in the registry"""
@@ -179,6 +190,7 @@ class Promtext:
         logging.basicConfig(level=self.args.loglevel)
         self.logger = logging.getLogger(__name__)
 
+        self._config()
         self.parse_file()
         self._build_metrics()
         self.output_file()

{promtext_cli-0.2.1.dev7 → promtext_cli-0.2.1.dev9}/tests/test_functional.py

@@ -23,6 +23,24 @@ def test_new_file(tmp_path):
     )
 
 
+def test_default_filename(tmp_path, monkeypatch):
+    """Does the command create a new file in default directory?"""
+    promfile = tmp_path / "test_metric.prom"
+    monkeypatch.setenv("PROMTEXT_DIR", str(tmp_path))
+
+    with ArgvContext("promtext", "test_metric", "0"):
+        promtext_main()
+    assert promfile.exists()
+    assert promfile.read_text() == (
+        "# HELP test_metric metric appended by promtext-cli"
+        "\n"
+        "# TYPE test_metric gauge"
+        "\n"
+        "test_metric 0.0"
+        "\n"
+    )
+
+
 def test_labels(tmp_path):
     """Does the command create a new file with metrics content?"""
     promfile = tmp_path / "label_file.prom"