{"id":15069102,"url":"https://github.com/pavlmits/pinkpony","last_synced_at":"2025-04-10T16:51:40.220Z","repository":{"id":46617868,"uuid":"196375701","full_name":"Pavlmits/PinkPony","owner":"Pavlmits","description":"Mining from git history with Pink Pony!","archived":false,"fork":false,"pushed_at":"2023-12-05T22:22:05.000Z","size":1064,"stargazers_count":9,"open_issues_count":3,"forks_count":5,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-24T14:44:24.633Z","etag":null,"topics":["git","graph-clustering","hacktoberfest","java","java-11","mining-software-repositories"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Pavlmits.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-07-11T10:45:46.000Z","updated_at":"2022-10-21T15:16:01.000Z","dependencies_parsed_at":"2024-10-13T03:40:52.655Z","dependency_job_id":null,"html_url":"https://github.com/Pavlmits/PinkPony","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pavlmits%2FPinkPony","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pavlmits%2FPinkPony/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pavlmits%2FPinkPony/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pavlmits%2FPinkPony/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Pavlmits","download_url":"https://codeload.github.com/Pavlmits/PinkPony/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248256033,"owners_count":21073445,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["git","graph-clustering","hacktoberfest","java","java-11","mining-software-repositories"],"created_at":"2024-09-25T01:40:29.706Z","updated_at":"2025-04-10T16:51:40.205Z","avatar_url":"https://github.com/Pavlmits.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PinkPony\nPink pony is an open-source software command-line application that suggests functional clusters based on the common changes on git.\nFunctionally related files are grouped into the same cluster. In this way the tool can help to split a monolithic application into a set of microservices.\n\u003e \u003ci\u003e What changes together should be also together \u003c/i\u003e\n\n## Result\nThe application produces 2 files:\n* `cluster.txt`: contains clusters;\n* `graphViz.dot`: a [.dot](https://en.wikipedia.org/wiki/DOT_(graph_description_language)) file to visualize the co-change graph.\n\n## Usage\nTo run the Pink pony application you have to download the [recently released version](https://github.com/Pavlmits/PinkPony/releases/latest).\n\n#### Clustering algorithms options\n* `mr`: [Markov Clustering] is a hard clustering algorithm;\n* `ch`: [Chinese Whispers] is a hard clustering algorithm;\n* `max`: [MaxMax] is a soft clustering algorithm for undirected graphs;\n* `watset`: [Watset] is a *local-global meta-algorithm* for fuzzy graph clustering.\n\nThe implementation of the algorithms used from [Watset project](https://github.com/nlpub/watset-java)\n\n#### Level of clustering\n\nDepending on the investigation that you want to do, the application provides two options:\n* `file` : Suggests functional clusters on file level. \n* `module` : Suggests functional clusters on module level.\n\n* This will suggest functional clusters from files.\n```bash\n$ java -jar pinkpony.jar path\\to\\.git file max\n```\n* This will suggest modules under the specific module\n##### Example\n###### input\n\u003cpre\u003e\nmoduleName\n    file1\n    file2\n    ...\n    fileN\n\u003c/pre\u003e\n\n###### output \n\u003cpre\u003e\n    cluster1\n        file1\n        file3\n    cluster2\n        file6\n        file89\n        ...\n    clusterN\n        file2\n        file15\n\u003c/pre\u003e\n```bash\n$ java -jar pinkpony.jar path\\to\\.git file max moduleName\n```\n\n* The following command will suggest new co-change modules from the submodules of mod1, mod2, mod3 with the [Markov Clustering] algorithm.\n##### Example\n###### input \n\u003cpre\u003e\nmod1\n    subMod1 \n    sudMod2 \n    subMod3 \nmod2 \n    subMod4 \n    sudMod5 \nmod3 \n    subMod6 \n    sudMod7 \n    subMod8 \n    subMod9 \n \u003c/pre\u003e\n###### output\n\u003cpre\u003e \ncluster1        \n    subMod3\n    subMod9\n    subMod8\ncluster2\n    subMod4\n    subMod5\n    subMod1\n...\n\u003c/pre\u003e\n    \n```bash\n$ java -jar pinkpony.jar path\\to\\.git module mr mod1 mod1 mod2  \n```\n\nThe Pink Pony application is a part of my thesis project.\n\n[Markov Clustering]: https://doi.org/10.1137/040608635\n[Chinese Whispers]: https://dl.acm.org/citation.cfm?id=1654774\n[MaxMax]: https://doi.org/10.1007/978-3-642-37247-6_30\n[Watset]: https://doi.org/10.1162/COLI_a_00354\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpavlmits%2Fpinkpony","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpavlmits%2Fpinkpony","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpavlmits%2Fpinkpony/lists"}