Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cdsap/ProjectGraphMetrics
Generate Graph metrics from dot file
https://github.com/cdsap/ProjectGraphMetrics
Last synced: 3 months ago
JSON representation
Generate Graph metrics from dot file
- Host: GitHub
- URL: https://github.com/cdsap/ProjectGraphMetrics
- Owner: cdsap
- License: mit
- Created: 2023-11-29T18:15:12.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2023-12-22T22:00:59.000Z (6 months ago)
- Last Synced: 2024-01-17T02:29:02.712Z (5 months ago)
- Language: Kotlin
- Homepage:
- Size: 92.8 KB
- Stars: 21
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-list - cdsap/ProjectGraphMetrics - Generate Graph metrics from dot file (Kotlin)
README
## Project Graph Metrics
Given a `.dot` file, it returns the following graph metrics:
* Indegree
* Outdegree
* Betweenness Centrality
* Height
### Usage
#### Library
Dependency:
```kotlin
dependencies {
implementation("io.github.cdsap:projectgraphmetrics:0.1.0")
}
```
Get metrics:
```kotlin
GraphParser(filePath).getIndicatorsByModule()
```
#### CLI
Example `nowinandroid`
```kotlin
./projetGraphMetrics --file=nowinandroid.dot
┌────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ Top Ten Module Report │
├──────────────────────────┬─────────────────────────┬────────────────────────────┬──────────────────────────┤
│ Indegree │ Outdegree │ BetweennessCentrality │ Height │
├─────────────────────┬────┼────────────────────┬────┼────────────────────┬───────┼──────────────────────┬───┤
│ :core:model │ 16 │ :app │ 13 │ :core:data │ 72.0 │ :app │ 7 │
├─────────────────────┼────┼────────────────────┼────┼────────────────────┼───────┼──────────────────────┼───┤
│ :core:common │ 15 │ :feature:search │ 10 │ :core:datastore │ 16.5 │ :feature:search │ 6 │
├─────────────────────┼────┼────────────────────┼────┼────────────────────┼───────┼──────────────────────┼───┤
│ :core:data │ 12 │ :core:testing │ 7 │ :core:testing │ 14.5 │ :sync:sync-test │ 5 │
├─────────────────────┼────┼────────────────────┼────┼────────────────────┼───────┼──────────────────────┼───┤
│ :core:analytics │ 11 │ :core:data │ 7 │ :core:domain │ 14.0 │ :core:datastore-test │ 5 │
├─────────────────────┼────┼────────────────────┼────┼────────────────────┼───────┼──────────────────────┼───┤
│ :core:designsystem │ 10 │ :feature:settings │ 7 │ :core:ui │ 10.14 │ :core:data-test │ 5 │
├─────────────────────┼────┼────────────────────┼────┼────────────────────┼───────┼──────────────────────┼───┤
│ :core:domain │ 8 │ :feature:topic │ 7 │ :sync:work │ 3.0 │ :app-nia-catalog │ 5 │
├─────────────────────┼────┼────────────────────┼────┼────────────────────┼───────┼──────────────────────┼───┤
│ :core:ui │ 8 │ :feature:bookmarks │ 7 │ :feature:settings │ 0.14 │ :feature:settings │ 5 │
├─────────────────────┼────┼────────────────────┼────┼────────────────────┼───────┼──────────────────────┼───┤
│ :core:testing │ 3 │ :feature:foryou │ 7 │ :feature:search │ 0.14 │ :feature:topic │ 5 │
├─────────────────────┼────┼────────────────────┼────┼────────────────────┼───────┼──────────────────────┼───┤
│ :core:datastore │ 3 │ :feature:interests │ 7 │ :feature:topic │ 0.14 │ :feature:bookmarks │ 5 │
├─────────────────────┼────┼────────────────────┼────┼────────────────────┼───────┼──────────────────────┼───┤
│ :core:notifications │ 2 │ :sync:work │ 5 │ :feature:bookmarks │ 0.14 │ :feature:foryou │ 5 │
└─────────────────────┴────┴────────────────────┴────┴────────────────────┴───────┴──────────────────────┴───┘
```
Additionally, the CLI generates the following files:
* `modules_report.csv`
* `modules_report.txt`
* `top_ten_module_report.txt`
##### Getting the CLI
```bash
curl -L https://github.com/cdsap/ProjectGraphMetrics/releases/download/v0.1.0/projectGraphMetrics --output projectGraphMetrics
chmod 0757 projectGraphMetrics
```
### Generating Dot files
Gradle Plugins generating graph files:
- [jraska/modules-graph-assert](https://github.com/jraska/modules-graph-assert)
```bash
./gradlew generateModulesGraphvizText -Pmodules.graph.output.gv=all_modules
```
- [autonomousapps/dependency-analysis-gradle-plugin](https://github.com/autonomousapps/dependency-analysis-gradle-plugin)
- [siggijons/graph-untangler-plugin](https://github.com/siggijons/graph-untangler-plugin)
### Libraries used
* [clikt](https://github.com/ajalt/clikt)
* [jgrapht-core](https://github.com/jgrapht/jgrapht)
* [kotlin-statistics](https://central.sonatype.com/artifact/org.nield/kotlin-statistics)
* [picnic](https://github.com/JakeWharton/picnic)https://github.com/JakeWharton/picnic
* [fatBinary](https://github.com/cdsap/FatBinary)https://github.com/cdsap/FatBinary