release v0.1.1

Author: alexpirogovqastudio

README.md

@@ -1,3 +1,22 @@
-# UCMA | Std Metrics Calculator Plugin
+# UCMA | Std Proxy Metrics Calculator Plugin
 
 Metrics plugin, which can be used to calculate source code tree metrics with external programs or plugins using `stdin`, `stdout` and `stderr` streams.
+
+**Install**
+
+``` bash
+poetry add git+https://github.com/Universal-code-metrics-analyzer/std-proxy-metrics-calculator.git@v0.1.1
+```
+
+**Runner configuration**
+
+``` yaml
+# config.yml
+
+metrics_calculator:
+  plugin: std_proxy_metrics_calculator
+  config:
+    cmd: "cmd to execute"
+    # try to coerce stdout json keys to snake case
+    preprocess_keys: True
+```

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
-name = "std_metrics_calculator"
-version = "0.1.0"
+name = "std_proxy_metrics_calculator"
+version = "0.1.1"
 description = ""
 authors = ["Alex Pirogov <pirogovalexandr00@mail.ru>"]
 readme = "README.md"
@@ -44,4 +44,4 @@ known_first_party = ["."]
 
 
 [tool.poetry.plugins."ucma.metrics_calculator.plugin"]
-export = "std_metrics_calculator.calculator:StdMetricsCalculator"
+export = "std_proxy_metrics_calculator.calculator:StdProxyMetricsCalculator"

std_metrics_calculator/calculator.py renamed to std_proxy_metrics_calculator/calculator.py

@@ -11,7 +11,7 @@
 from pydantic.alias_generators import to_snake
 
 
-class StdMetricsCalculatorConfigShape(MetricsCalculatorConfigShape):
+class StdProxyMetricsCalculatorConfigShape(MetricsCalculatorConfigShape):
     cmd: str
     preprocess_keys: bool = False
 
@@ -26,9 +26,9 @@ def dict_to_snake_keys[T: dict[str, Any]](data: T) -> T:
     return {to_snake(k): dict_to_snake_keys(v) for k, v in data.items()}
 
 
-class StdMetricsCalculator(
-    MetricsCalculator[StdMetricsCalculatorConfigShape],
-    config_shape=StdMetricsCalculatorConfigShape,
+class StdProxyMetricsCalculator(
+    MetricsCalculator[StdProxyMetricsCalculatorConfigShape],
+    config_shape=StdProxyMetricsCalculatorConfigShape,
 ):
     async def calculate(self) -> TreeMetrics:
         proc = await asyncio.create_subprocess_shell(