metripy 0.2.7__tar.gz → 0.2.8__tar.gz

{metripy-0.2.7 → metripy-0.2.8}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 CodeMetrics
+Copyright (c) 2024 Metripy
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{metripy-0.2.7 → metripy-0.2.8}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: metripy
-Version: 0.2.7
+Version: 0.2.8
 Summary: A Python tool to generate multi project, multi language code metric reports
 Author-email: Yannick Zimmermann <yannick.zimmermann@proton.me>
 License: MIT
-Project-URL: Homepage, https://github.com/zimmer-yan/codemetrics
-Project-URL: Repository, https://github.com/zimmer-yan/codemetrics
-Project-URL: Documentation, https://github.com/zimmer-yan/codemetrics#readme
-Project-URL: Bug Tracker, https://github.com/zimmer-yan/codemetrics/issues
+Project-URL: Homepage, https://github.com/zimmer-yan/metripy
+Project-URL: Repository, https://github.com/zimmer-yan/metripy
+Project-URL: Documentation, https://github.com/zimmer-yan/metripy#readme
+Project-URL: Bug Tracker, https://github.com/zimmer-yan/metripy/issues
 Keywords: code metrics,multi-language,code analysis,git metrics,code visualization,software quality,static analysis,repository insights,developer productivity,codebase health,technical debt,language-agnostic
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
@@ -37,7 +37,7 @@ Requires-Dist: poethepoet==0.37.0; extra == "dev"
 Requires-Dist: isort==7.0.0; extra == "dev"
 Dynamic: license-file
 
-# Codemetrics
+# Metripy
 A multilanguage, multi project code metrics analysis tool. 
 
 # Languages
@@ -102,8 +102,8 @@ Sample configuraiton:
             "pip": true,
             // looks for base_path/requirements.txt or base_path/pyproject.toml and analyzes dependencies - for python projects
             "reports": {
-                "html": "./build/report/codemetrics", // report should be put into this directory
-                "json-git": "./build/json-report/codemetrics-git.json" // file where to put git json report
+                "html": "./build/report/metripy", // report should be put into this directory
+                "json-git": "./build/json-report/metripy-git.json" // file where to put git json report
                 // more types of reports TBA
             }
         },
@@ -111,3 +111,20 @@ Sample configuraiton:
     }
 }
 ```
+
+## Configuration for only git stats
+```json
+{
+    "configs": {
+        "metripy-git": {
+            "base_path": "./",
+            "git": {
+                "branch": "main"
+            },
+            "reports": {
+                "json-git": "./build/json-report/metripy-git.json"
+            }
+        }
+    }
+}
+```

{metripy-0.2.7 → metripy-0.2.8}/README.md

@@ -1,4 +1,4 @@
-# Codemetrics
+# Metripy
 A multilanguage, multi project code metrics analysis tool. 
 
 # Languages
@@ -63,8 +63,8 @@ Sample configuraiton:
             "pip": true,
             // looks for base_path/requirements.txt or base_path/pyproject.toml and analyzes dependencies - for python projects
             "reports": {
-                "html": "./build/report/codemetrics", // report should be put into this directory
-                "json-git": "./build/json-report/codemetrics-git.json" // file where to put git json report
+                "html": "./build/report/metripy", // report should be put into this directory
+                "json-git": "./build/json-report/metripy-git.json" // file where to put git json report
                 // more types of reports TBA
             }
         },
@@ -72,3 +72,20 @@ Sample configuraiton:
     }
 }
 ```
+
+## Configuration for only git stats
+```json
+{
+    "configs": {
+        "metripy-git": {
+            "base_path": "./",
+            "git": {
+                "branch": "main"
+            },
+            "reports": {
+                "json-git": "./build/json-report/metripy-git.json"
+            }
+        }
+    }
+}
+```

{metripy-0.2.7 → metripy-0.2.8}/metripy/Application/Config/Parser.py

@@ -9,8 +9,8 @@ class Parser:
     def parse(self, argv: list[str]) -> Config:
         config = Config()
 
-        if argv[0] == "codemetrics.py" or argv[0] == "codemetrics":
-            # TODO, fix when path ends with codemetrics.py
+        if argv[0] == "metripy.py" or argv[0] == "metripy":
+            # TODO, fix when path ends with metripy.py
             pass
         argv.pop(0)
 

{metripy-0.2.7 → metripy-0.2.8}/metripy/Dependency/Dependency.py

@@ -1,5 +1,7 @@
+from typing import Self
+
 class Dependency:
-    def __init__(self, name: str, version: str):
+    def __init__(self, name: str, version: str|None):
         self.name = name
         self.version = version
         self.latest: str = ""
@@ -28,3 +30,16 @@ class Dependency:
             "downloads_monthly": self.downloads_monthly,
             "licenses": ",".join(self.license),
         }
+
+    @staticmethod
+    def get_lisence_distribution(dependencies: list[Self]) -> dict[str, int]:
+        license_by_type = {}
+
+        dependency: Dependency
+        for dependency in dependencies:
+            for license_name in dependency.license:
+                if license_name not in license_by_type.keys():
+                    license_by_type[license_name] = 0
+                license_by_type[license_name] += 1
+
+        return license_by_type

{metripy-0.2.7 → metripy-0.2.8}/metripy/Dependency/Pip/Pip.py

@@ -23,47 +23,38 @@ class Pip:
         return [item for item in packages if item is not None]
 
     def get_from_requirements_txt(self, path: str) -> list[Dependency]:
-        requirements = []
-
-        pattern = re.compile(r"([a-zA-Z0-9_\-]+)([<>=!~]+[^\s]+)?")
         with open(os.path.join(path, "requirements.txt"), "r") as file:
             lines = file.readlines()
-            for line in lines:
+            return self._parse_dependencies(lines)
 
-                line = line.strip()
-                if line and not line.startswith("#"):
-                    match = pattern.match(line)
-                    if match:
-                        name = match.group(1)
-                        version = match.group(2) if match.group(2) else None
-                        requirements.append(Dependency(name, version))
-        return requirements
+        return []
 
     def get_from_pyproject_toml(self, path: str) -> list[Dependency]:
-        dependencies = []
-
         with open(os.path.join(path, "pyproject.toml"), "r") as f:
             data = toml.load(f)
 
             # For PEP 621 / setuptools projects
             if "project" in data:
                 deps = data["project"].get("dependencies", [])
-                for dep in deps:
-                    # dep is a string like "requests>=2.32.5"
-                    # You can split it if needed
-                    if "==" in dep:
-                        name, version = dep.split("==")
-                    elif ">=" in dep:
-                        name, version = dep.split(">=")
-                    else:
-                        name, version = dep, None
-                    dependencies.append(
-                        Dependency(name.strip(), version.strip() if version else None)
-                    )
-
-        return dependencies
+                return self._parse_dependencies(deps)
 
+        return []
+    
+    def _parse_dependencies(self, lines: list[str]) -> list[Dependency]:
+        dependencies = []
+        for dep in lines:
+            dep = dep.strip()
+            if not dep or dep.startswith("#"):
+                continue
+            # dep is a string like "requests>=2.32.5"
+            if "==" in dep:
+                name, version = dep.split("==")
+            elif ">=" in dep:
+                name, version = dep.split(">=")
+            else:
+                name, version = dep, None
+            dependencies.append(
+                Dependency(name.strip(), version.strip() if version else None)
+            )
 
-if __name__ == "__main__":
-    pip = Pip()
-    pip.get_dependencies("./")
+        return dependencies

{metripy-0.2.7 → metripy-0.2.8}/metripy/Metric/ProjectMetrics.py

@@ -3,6 +3,7 @@ from metripy.Metric.Code.AggregatedMetrics import AggregatedMetrics
 from metripy.Metric.Code.FileMetrics import FileMetrics
 from metripy.Metric.Code.SegmentedMetrics import SegmentedMetrics
 from metripy.Metric.Git.GitMetrics import GitMetrics
+from metripy.Dependency.Dependency import Dependency
 
 
 class ProjectMetrics:
@@ -53,3 +54,16 @@ class ProjectMetrics:
 
     def _avg(self, items: list[float | int]) -> float:
         return sum(items) / len(items)
+
+    def to_dict(self) -> dict:
+        data = {
+            "file_metrics": [m.to_dict() for m in self.file_metrics],
+            "aggregated": self.total_code_metrics.to_dict(),
+            "aggregated_segmented": self.total_code_metrics.to_dict_segmentation(),
+        }
+        if self.git_metrics:
+            data["git_metrics"] = self.git_metrics.to_dict()
+        if self.dependencies:
+            data["dependencies"] = [d.to_dict() for d in self.dependencies]
+            data["license_distribution"] = Dependency.get_lisence_distribution(self.dependencies)
+        return data

{metripy-0.2.7 → metripy-0.2.8}/metripy/Report/Html/Reporter.py

@@ -10,6 +10,7 @@ from metripy.Component.Output.CliOutput import CliOutput
 from metripy.Metric.FileTree.FileTreeParser import FileTreeParser
 from metripy.Metric.ProjectMetrics import ProjectMetrics
 from metripy.Report.ReporterInterface import ReporterInterface
+from metripy.Dependency.Dependency import Dependency
 
 
 class Reporter(ReporterInterface):
@@ -71,10 +72,10 @@ class Reporter(ReporterInterface):
                 "segmentation_data": json.dumps(
                     metrics.total_code_metrics.to_dict_segmentation(), indent=4
                 ),
-                "project_name": "CodeMetrics",
+                "project_name": "Metripy",
                 "last_updated": datetime.now().strftime("%Y-%m-%d %H:%M:%S"),
                 "date": datetime.now().strftime("%Y-%m-%d %H:%M:%S"),
-                "author": "CodeMetrics",
+                "author": "Metripy",
                 "version": "1.0.0",
             },
         )
@@ -107,14 +108,8 @@ class Reporter(ReporterInterface):
 
         dependencies = metrics.dependencies if metrics.dependencies is not None else []
 
-        license_by_type = {}
-
         # TODO render a pie chart
-        for dependency in dependencies:
-            for license_name in dependency.license:
-                if license_name not in license_by_type.keys():
-                    license_by_type[license_name] = 0
-                license_by_type[license_name] += 1
+        license_by_type = Dependency.get_lisence_distribution(dependencies)
 
         print(json.dumps(license_by_type, indent=2))
 
@@ -122,7 +117,7 @@ class Reporter(ReporterInterface):
             "dependencies.html",
             {
                 "dependencies": [d.to_dict() for d in dependencies],
-                "project_name": "CodeMetrics",
+                "project_name": "Metripy",
                 "last_updated": datetime.now().strftime("%Y-%m-%d %H:%M:%S"),
             },
         )
@@ -148,7 +143,7 @@ class Reporter(ReporterInterface):
             {
                 "filetree": json.dumps(filetree.to_dict()),
                 "file_details": json.dumps(file_details),
-                "project_name": "CodeMetrics",
+                "project_name": "Metripy",
                 "last_updated": datetime.now().strftime("%Y-%m-%d %H:%M:%S"),
             },
         )
@@ -194,7 +189,7 @@ class Reporter(ReporterInterface):
                         "git_hotspots_data": metrics.git_metrics.get_hotspots_list()[
                             :10
                         ],  # hotspots list
-                        "project_name": "CodeMetrics",
+                        "project_name": "Metripy",
                         "last_updated": metrics.git_metrics.get_analysis_start_date(),
                     }
                 ),

{metripy-0.2.7 → metripy-0.2.8}/metripy/Report/Json/GitJsonReporter.py

@@ -19,3 +19,4 @@ class GitJsonReporter(AbstractJsonReporter):
         }
 
         self.put_data(data)
+        self.output.writeln(f"<success>Create git json report in {self.config.path}</success>")

{metripy-0.2.7 → metripy-0.2.8}/metripy/Report/Json/JsonReporter.py

@@ -1,12 +1,13 @@
 from metripy.Application.Config.Config import Config
 from metripy.Component.Output.CliOutput import CliOutput
 from metripy.Metric.ProjectMetrics import ProjectMetrics
+from metripy.Report.Json.AbstractJsonReporter import AbstractJsonReporter
 
-
-class JsonReporter:
+class JsonReporter(AbstractJsonReporter):
     def __init__(self, config: Config, output: CliOutput):
         self.config = config
         self.output = output
 
     def generate(self, metrics: ProjectMetrics):
-        raise NotImplementedError
+        self.put_data(metrics.to_dict())
+        self.output.writeln(f"<success>Create json report in {self.config.path}</success>")

{metripy-0.2.7 → metripy-0.2.8}/metripy/Report/ReporterFactory.py

@@ -3,6 +3,7 @@ from metripy.Component.Output.CliOutput import CliOutput
 from metripy.Report import ReporterInterface
 from metripy.Report.Html.Reporter import Reporter as HtmlReporter
 from metripy.Report.Json.GitJsonReporter import GitJsonReporter
+from metripy.Report.Json.JsonReporter import JsonReporter
 
 
 class ReporterFactory:
@@ -11,7 +12,7 @@ class ReporterFactory:
         if config.type == "html":
             return HtmlReporter(config, output)
         elif config.type == "json":
-            raise NotImplementedError
+            return JsonReporter(config, output)
         elif config.type == "csv":
             raise NotImplementedError
         elif config.type == "cli":

{metripy-0.2.7 → metripy-0.2.8}/metripy.egg-info/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: metripy
-Version: 0.2.7
+Version: 0.2.8
 Summary: A Python tool to generate multi project, multi language code metric reports
 Author-email: Yannick Zimmermann <yannick.zimmermann@proton.me>
 License: MIT
-Project-URL: Homepage, https://github.com/zimmer-yan/codemetrics
-Project-URL: Repository, https://github.com/zimmer-yan/codemetrics
-Project-URL: Documentation, https://github.com/zimmer-yan/codemetrics#readme
-Project-URL: Bug Tracker, https://github.com/zimmer-yan/codemetrics/issues
+Project-URL: Homepage, https://github.com/zimmer-yan/metripy
+Project-URL: Repository, https://github.com/zimmer-yan/metripy
+Project-URL: Documentation, https://github.com/zimmer-yan/metripy#readme
+Project-URL: Bug Tracker, https://github.com/zimmer-yan/metripy/issues
 Keywords: code metrics,multi-language,code analysis,git metrics,code visualization,software quality,static analysis,repository insights,developer productivity,codebase health,technical debt,language-agnostic
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
@@ -37,7 +37,7 @@ Requires-Dist: poethepoet==0.37.0; extra == "dev"
 Requires-Dist: isort==7.0.0; extra == "dev"
 Dynamic: license-file
 
-# Codemetrics
+# Metripy
 A multilanguage, multi project code metrics analysis tool. 
 
 # Languages
@@ -102,8 +102,8 @@ Sample configuraiton:
             "pip": true,
             // looks for base_path/requirements.txt or base_path/pyproject.toml and analyzes dependencies - for python projects
             "reports": {
-                "html": "./build/report/codemetrics", // report should be put into this directory
-                "json-git": "./build/json-report/codemetrics-git.json" // file where to put git json report
+                "html": "./build/report/metripy", // report should be put into this directory
+                "json-git": "./build/json-report/metripy-git.json" // file where to put git json report
                 // more types of reports TBA
             }
         },
@@ -111,3 +111,20 @@ Sample configuraiton:
     }
 }
 ```
+
+## Configuration for only git stats
+```json
+{
+    "configs": {
+        "metripy-git": {
+            "base_path": "./",
+            "git": {
+                "branch": "main"
+            },
+            "reports": {
+                "json-git": "./build/json-report/metripy-git.json"
+            }
+        }
+    }
+}
+```

{metripy-0.2.7 → metripy-0.2.8}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "metripy"
-version = "0.2.7"
+version = "0.2.8"
 description = "A Python tool to generate multi project, multi language code metric reports"
 authors = [
     {name = "Yannick Zimmermann", email = "yannick.zimmermann@proton.me"}
@@ -59,10 +59,10 @@ dev = [
 ]
 
 [project.urls]
-Homepage = "https://github.com/zimmer-yan/codemetrics"
-Repository = "https://github.com/zimmer-yan/codemetrics"
-Documentation = "https://github.com/zimmer-yan/codemetrics#readme"
-"Bug Tracker" = "https://github.com/zimmer-yan/codemetrics/issues"
+Homepage = "https://github.com/zimmer-yan/metripy"
+Repository = "https://github.com/zimmer-yan/metripy"
+Documentation = "https://github.com/zimmer-yan/metripy#readme"
+"Bug Tracker" = "https://github.com/zimmer-yan/metripy/issues"
 
 [project.scripts]
 metripy="metripy.metripy:main"