metripy 0.2.5__tar.gz

metripy-0.2.5/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 CodeMetrics
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

metripy-0.2.5/PKG-INFO

@@ -0,0 +1,112 @@
+Metadata-Version: 2.4
+Name: metripy
+Version: 0.2.5
+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
+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
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: lizard==1.18.0
+Requires-Dist: GitPython==3.1.45
+Requires-Dist: py-template-engine>=0.1.0
+Requires-Dist: radon==6.0.1
+Requires-Dist: requests==2.32.5
+Requires-Dist: packaging==25.0
+Requires-Dist: toml==0.10.2
+Requires-Dist: tree-sitter==0.21.3
+Requires-Dist: tree-sitter-languages==1.10.2
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov==7.0.0; extra == "dev"
+Requires-Dist: pytest-mock==3.15.1; extra == "dev"
+Requires-Dist: black>=22.0.0; extra == "dev"
+Requires-Dist: flake8>=5.0.0; extra == "dev"
+Requires-Dist: mypy>=0.991; extra == "dev"
+Requires-Dist: poethepoet==0.37.0; extra == "dev"
+Dynamic: license-file
+
+# Codemetrics
+A multilanguage, multi project code metrics analysis tool. 
+
+# Languages
+Supported languages
+- Python (with radon)
+- Php (experimental)
+- Typescript (experimental)
+- TBD
+
+# Analysis types
+
+## Code analysis
+Analyses code with cyclomatic complexity, maintainability index, halstead metrics.
+
+## Git analysis
+Analyses git stats of the past months
+
+## Dependeny analysis
+Analyzses composer, npm or pip dependencies
+
+More dependencies TBD
+
+# Report formats
+
+## Html
+Generates an easy to read dashboard
+
+TODO: as this application generates multi project reports, add central dashboard to have project specific insights at first glance
+
+## Csv
+Coming soon...
+
+## Json
+Coming soon...
+
+## Cli
+Coming soon...
+
+# Configuration
+Configuration is for the moment only possible with the `--config=<file>.json` option. More TBD
+
+Sample configuraiton:
+```json
+{
+    "configs": {
+        "funny codemetrics": {
+            "base_path": "./", // base path to look at
+            "includes": [
+                "src/" // paths to include from the base path on
+            ],
+            "excludes": [
+                "__pycache__" // exclude patterns of paths / files
+            ],
+            "extensions": [
+                "py" // file extensions to look at
+            ],
+            "git": { // if git is set, analyzes git history
+                "branch": "main" // git branch to look at
+            },
+            "composer": true, // looks for base_path/composer.json and analyzes dependencies - for php projects
+            "npm": true, // looks for base_path/package.json and analyzes dependencies - for ts/js projects
+            "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
+                // more types of reports TBA
+            }
+        },
+        // next project name: { next config... } 
+    }
+}
+```

metripy-0.2.5/README.md

@@ -0,0 +1,74 @@
+# Codemetrics
+A multilanguage, multi project code metrics analysis tool. 
+
+# Languages
+Supported languages
+- Python (with radon)
+- Php (experimental)
+- Typescript (experimental)
+- TBD
+
+# Analysis types
+
+## Code analysis
+Analyses code with cyclomatic complexity, maintainability index, halstead metrics.
+
+## Git analysis
+Analyses git stats of the past months
+
+## Dependeny analysis
+Analyzses composer, npm or pip dependencies
+
+More dependencies TBD
+
+# Report formats
+
+## Html
+Generates an easy to read dashboard
+
+TODO: as this application generates multi project reports, add central dashboard to have project specific insights at first glance
+
+## Csv
+Coming soon...
+
+## Json
+Coming soon...
+
+## Cli
+Coming soon...
+
+# Configuration
+Configuration is for the moment only possible with the `--config=<file>.json` option. More TBD
+
+Sample configuraiton:
+```json
+{
+    "configs": {
+        "funny codemetrics": {
+            "base_path": "./", // base path to look at
+            "includes": [
+                "src/" // paths to include from the base path on
+            ],
+            "excludes": [
+                "__pycache__" // exclude patterns of paths / files
+            ],
+            "extensions": [
+                "py" // file extensions to look at
+            ],
+            "git": { // if git is set, analyzes git history
+                "branch": "main" // git branch to look at
+            },
+            "composer": true, // looks for base_path/composer.json and analyzes dependencies - for php projects
+            "npm": true, // looks for base_path/package.json and analyzes dependencies - for ts/js projects
+            "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
+                // more types of reports TBA
+            }
+        },
+        // next project name: { next config... } 
+    }
+}
+```

metripy-0.2.5/metripy.egg-info/PKG-INFO

@@ -0,0 +1,112 @@
+Metadata-Version: 2.4
+Name: metripy
+Version: 0.2.5
+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
+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
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: lizard==1.18.0
+Requires-Dist: GitPython==3.1.45
+Requires-Dist: py-template-engine>=0.1.0
+Requires-Dist: radon==6.0.1
+Requires-Dist: requests==2.32.5
+Requires-Dist: packaging==25.0
+Requires-Dist: toml==0.10.2
+Requires-Dist: tree-sitter==0.21.3
+Requires-Dist: tree-sitter-languages==1.10.2
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov==7.0.0; extra == "dev"
+Requires-Dist: pytest-mock==3.15.1; extra == "dev"
+Requires-Dist: black>=22.0.0; extra == "dev"
+Requires-Dist: flake8>=5.0.0; extra == "dev"
+Requires-Dist: mypy>=0.991; extra == "dev"
+Requires-Dist: poethepoet==0.37.0; extra == "dev"
+Dynamic: license-file
+
+# Codemetrics
+A multilanguage, multi project code metrics analysis tool. 
+
+# Languages
+Supported languages
+- Python (with radon)
+- Php (experimental)
+- Typescript (experimental)
+- TBD
+
+# Analysis types
+
+## Code analysis
+Analyses code with cyclomatic complexity, maintainability index, halstead metrics.
+
+## Git analysis
+Analyses git stats of the past months
+
+## Dependeny analysis
+Analyzses composer, npm or pip dependencies
+
+More dependencies TBD
+
+# Report formats
+
+## Html
+Generates an easy to read dashboard
+
+TODO: as this application generates multi project reports, add central dashboard to have project specific insights at first glance
+
+## Csv
+Coming soon...
+
+## Json
+Coming soon...
+
+## Cli
+Coming soon...
+
+# Configuration
+Configuration is for the moment only possible with the `--config=<file>.json` option. More TBD
+
+Sample configuraiton:
+```json
+{
+    "configs": {
+        "funny codemetrics": {
+            "base_path": "./", // base path to look at
+            "includes": [
+                "src/" // paths to include from the base path on
+            ],
+            "excludes": [
+                "__pycache__" // exclude patterns of paths / files
+            ],
+            "extensions": [
+                "py" // file extensions to look at
+            ],
+            "git": { // if git is set, analyzes git history
+                "branch": "main" // git branch to look at
+            },
+            "composer": true, // looks for base_path/composer.json and analyzes dependencies - for php projects
+            "npm": true, // looks for base_path/package.json and analyzes dependencies - for ts/js projects
+            "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
+                // more types of reports TBA
+            }
+        },
+        // next project name: { next config... } 
+    }
+}
+```

metripy-0.2.5/metripy.egg-info/SOURCES.txt

@@ -0,0 +1,69 @@
+LICENSE
+README.md
+pyproject.toml
+metripy.egg-info/PKG-INFO
+metripy.egg-info/SOURCES.txt
+metripy.egg-info/dependency_links.txt
+metripy.egg-info/entry_points.txt
+metripy.egg-info/requires.txt
+metripy.egg-info/top_level.txt
+src/__init__.py
+src/codemetrics.py
+src/Application/Analyzer.py
+src/Application/Application.py
+src/Application/__init__.py
+src/Application/Config/Config.py
+src/Application/Config/GitConfig.py
+src/Application/Config/Parser.py
+src/Application/Config/ProjectConfig.py
+src/Application/Config/ReportConfig.py
+src/Application/Config/File/ConfigFileReaderFactory.py
+src/Application/Config/File/ConfigFileReaderInterface.py
+src/Application/Config/File/JsonConfigFileReader.py
+src/Component/Debug/Debugger.py
+src/Component/File/Finder.py
+src/Component/Output/CliOutput.py
+src/Component/Output/ProgressBar.py
+src/Dependency/Dependency.py
+src/Dependency/Composer/Composer.py
+src/Dependency/Composer/Packegist.py
+src/Dependency/Npm/Npm.py
+src/Dependency/Npm/NpmOrg.py
+src/Dependency/Pip/Pip.py
+src/Dependency/Pip/PyPi.py
+src/Git/GitAnalyzer.py
+src/LangAnalyzer/AbstractLangAnalyzer.py
+src/LangAnalyzer/__init__.py
+src/LangAnalyzer/Generic/HalSteadAnalyzer.py
+src/LangAnalyzer/Generic/__init__.py
+src/LangAnalyzer/Php/PhpAnalyzer.py
+src/LangAnalyzer/Php/PhpBasicAstParser.py
+src/LangAnalyzer/Php/PhpBasicLocAnalyzer.py
+src/LangAnalyzer/Php/PhpHalSteadAnalyzer.py
+src/LangAnalyzer/Python/PythonAnalyzer.py
+src/LangAnalyzer/Typescript/TypescriptAnalyzer.py
+src/LangAnalyzer/Typescript/TypescriptAstParser.py
+src/LangAnalyzer/Typescript/TypescriptBasicComplexityAnalyzer.py
+src/LangAnalyzer/Typescript/TypescriptBasicLocAnalyzer.py
+src/LangAnalyzer/Typescript/TypescriptHalSteadAnalyzer.py
+src/Metric/ProjectMetrics.py
+src/Metric/Code/AggregatedMetrics.py
+src/Metric/Code/FileMetrics.py
+src/Metric/Code/ModuleMetrics.py
+src/Metric/Code/SegmentedMetrics.py
+src/Metric/FileTree/FileTree.py
+src/Metric/FileTree/FileTreeParser.py
+src/Metric/Git/GitCodeHotspot.py
+src/Metric/Git/GitContributor.py
+src/Metric/Git/GitKnowledgeSilo.py
+src/Metric/Git/GitMetrics.py
+src/Report/ReporterFactory.py
+src/Report/ReporterInterface.py
+src/Report/Csv/Reporter.py
+src/Report/Html/Reporter.py
+src/Report/Json/AbstractJsonReporter.py
+src/Report/Json/GitJsonReporter.py
+src/Report/Json/JsonReporter.py
+src/Tree/ClassNode.py
+src/Tree/FunctionNode.py
+src/Tree/ModuleNode.py

metripy-0.2.5/metripy.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

metripy-0.2.5/metripy.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+codemetrics = src.codemetrics:main

metripy-0.2.5/metripy.egg-info/requires.txt

@@ -0,0 +1,18 @@
+lizard==1.18.0
+GitPython==3.1.45
+py-template-engine>=0.1.0
+radon==6.0.1
+requests==2.32.5
+packaging==25.0
+toml==0.10.2
+tree-sitter==0.21.3
+tree-sitter-languages==1.10.2
+
+[dev]
+pytest>=7.0.0
+pytest-cov==7.0.0
+pytest-mock==3.15.1
+black>=22.0.0
+flake8>=5.0.0
+mypy>=0.991
+poethepoet==0.37.0

metripy-0.2.5/metripy.egg-info/top_level.txt

@@ -0,0 +1 @@
+src

metripy-0.2.5/pyproject.toml

@@ -0,0 +1,81 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "metripy"
+version = "0.2.5"
+description = "A Python tool to generate multi project, multi language code metric reports"
+authors = [
+    {name = "Yannick Zimmermann", email = "yannick.zimmermann@proton.me"}
+]
+license = {text = "MIT"}
+readme = "README.md"
+requires-python = ">=3.11"
+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"
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12"
+]
+
+dependencies = [
+    "lizard==1.18.0",
+    "GitPython==3.1.45",
+    "py-template-engine>=0.1.0",
+    "radon==6.0.1",
+    "requests==2.32.5",
+    "packaging==25.0",
+    "toml==0.10.2",
+    "tree-sitter==0.21.3",
+    "tree-sitter-languages==1.10.2"
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0.0",
+    "pytest-cov==7.0.0",
+    "pytest-mock==3.15.1",
+    "black>=22.0.0",
+    "flake8>=5.0.0",
+    "mypy>=0.991",
+    "poethepoet==0.37.0"
+]
+
+[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"
+
+[project.scripts]
+codemetrics="src.codemetrics:main"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["src*"]
+
+[tool.black]
+line-length = 88
+target-version = ['py39']
+
+[tool.poe.tasks]
+format = "black src tests"
+lint = "flake8 src/ tests/"
+ruffy = "ruff check src/ tests/"
+test = "pytest tests/"

metripy-0.2.5/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

metripy-0.2.5/src/Application/Analyzer.py

@@ -0,0 +1,105 @@
+from Application.Config.ProjectConfig import ProjectConfig
+from Component.Debug.Debugger import Debugger
+from Component.Output.CliOutput import CliOutput
+from Component.Output.ProgressBar import ProgressBar
+from Dependency.Composer.Composer import Composer
+from Dependency.Dependency import Dependency
+from Dependency.Npm.Npm import Npm
+from Dependency.Pip.Pip import Pip
+from Git.GitAnalyzer import GitAnalyzer
+from LangAnalyzer.AbstractLangAnalyzer import AbstractLangAnalyzer
+from LangAnalyzer.Php.PhpAnalyzer import PhpAnalyzer
+from LangAnalyzer.Python.PythonAnalyzer import PythonAnalyzer
+from LangAnalyzer.Typescript.TypescriptAnalyzer import TypescriptAnalyzer
+from Metric.Code.FileMetrics import FileMetrics
+from Metric.Git.GitMetrics import GitMetrics
+from Metric.ProjectMetrics import ProjectMetrics
+
+
+class Analyzer:
+    def __init__(self, config: ProjectConfig, output: CliOutput, debugger: Debugger):
+        self.config = config
+        self.output = output
+        self.debugger = debugger
+        self.runners: list[AbstractLangAnalyzer] = [
+            PythonAnalyzer(),
+            PhpAnalyzer(),
+            TypescriptAnalyzer(),
+        ]
+
+    def analyze_git(self) -> GitMetrics:
+        self.output.writeln("<info>Analyzing git history...</info>")
+        metrics = GitAnalyzer(self.config.git).analyze()
+        self.output.writeln("<success>Git history analyzed</success>")
+
+        return metrics
+
+    def analyze_code(self, files: list[str]) -> list[FileMetrics]:
+        file_metrics = []
+
+        # for multi language projects, register runner per language
+        runner_sizes = []
+        for runner in self.runners:
+            runner.set_files(files)
+            if not runner.is_needed():
+                continue
+            runner_sizes.append(len(runner.files))
+
+        self.debugger.debug(len(files))
+        self.output.writeln("<info>Analyzing code...</info>")
+        progress_bar = ProgressBar(self.output, sum(runner_sizes))
+        for runner in self.runners:
+            if not runner.is_needed():
+                continue
+            runner.before_run()
+            runner.run(progress_bar)
+            runner.after_run()
+
+            for metric in runner.get_metrics():
+                file_metrics.append(metric)
+
+        self.output.writeln("")
+        self.output.writeln("<success>Code analyzed</success>")
+
+        return file_metrics
+
+    def analyze_composer(self) -> list[Dependency]:
+        self.output.writeln("<info>Analyzing composer packages...</info>")
+        dependencies = Composer().get_composer_dependencies(self.config.base_path)
+        self.output.writeln("<success>Composer packages analyzed</success>")
+
+        return dependencies
+
+    def analyze_pip(self) -> list[Dependency]:
+        self.output.writeln("<info>Analyzing pip packages...</info>")
+        dependencies = Pip().get_dependencies(self.config.base_path)
+        self.output.writeln("<success>Pip packages analyzed</success>")
+
+        return dependencies
+
+    def analyze_npm(self) -> list[Dependency]:
+        self.output.writeln("<info>Analyzing npm packages...</info>")
+        dependencies = Npm().get_dependencies(self.config.base_path)
+        self.output.writeln("<success>Npm packages analyzed</success>")
+
+        return dependencies
+
+    def run(self, files: list[str]) -> ProjectMetrics:
+        git_stats = None
+        if self.config.git:
+            git_stats = self.analyze_git()
+
+        file_metrics = []
+        if True:
+            file_metrics = self.analyze_code(files)
+
+        # TODO: analyze dependencies: composer, pip, npm, etc etc
+        packages = None
+        if self.config.composer:
+            packages = self.analyze_composer()
+        elif self.config.pip:
+            packages = self.analyze_pip()
+        elif self.config.npm:
+            packages = self.analyze_npm()
+
+        return ProjectMetrics(file_metrics, git_stats, packages)

metripy-0.2.5/src/Application/Application.py

@@ -0,0 +1,54 @@
+import json
+
+from Application.Analyzer import Analyzer
+from Application.Config.Parser import Parser
+from Component.Debug.Debugger import Debugger
+from Component.File.Finder import Finder
+from Component.Output.CliOutput import CliOutput
+from Report.ReporterFactory import ReporterFactory
+from Report.ReporterInterface import ReporterInterface
+
+
+class Application:
+    def run(self, argv) -> None:
+        output = CliOutput()
+
+        # issues and debug
+        debugger = Debugger(output).enable()
+
+        config = Parser().parse(argv)
+
+        finder = Finder()
+        files = finder.fetch(config.project_configs)
+
+        for project_config in config.project_configs:
+            debugger.debug(project_config.name)
+            project_files = files[project_config.name]
+            debugger.debug(f"Found {len(project_files)} files")
+            debugger.debug(json.dumps(project_files))
+
+            output.writeln(f"<info>Analying Project {project_config.name}...</info>")
+            project_metrics = Analyzer(project_config, output, debugger).run(
+                project_files
+            )
+            output.writeln(
+                f"<success>Done analying Project {project_config.name}</success>"
+            )
+
+            if not project_config.reports:
+                output.writeln(
+                    f"<success>Skipping reports of {project_config.name}!</success>"
+                )
+                continue
+
+            output.writeln(
+                f"<info>Generating reports for {project_config.name}...</info>"
+            )
+            for report_config in project_config.reports:
+                reporter: ReporterInterface = ReporterFactory.create(
+                    report_config, output
+                )
+                reporter.generate(project_metrics)
+            output.writeln(
+                f"<success>Reports generated for {project_config.name}</success>"
+            )

metripy-0.2.5/src/Application/Config/Config.py

@@ -0,0 +1,13 @@
+from Application.Config.ProjectConfig import ProjectConfig
+
+
+class Config:
+    def __init__(self):
+        self.project_configs: list[ProjectConfig] = []
+
+    def to_dict(self) -> dict:
+        return {
+            "project_configs": [
+                project_config.to_dict() for project_config in self.project_configs
+            ],
+        }