{"id":32986282,"url":"https://github.com/stefandtw/gitk-class-diagram","last_synced_at":"2026-01-14T08:53:20.881Z","repository":{"id":57434678,"uuid":"233412274","full_name":"stefandtw/gitk-class-diagram","owner":"stefandtw","description":"Class diagrams based on commit diffs","archived":false,"fork":false,"pushed_at":"2021-01-21T19:22:36.000Z","size":134,"stargazers_count":12,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-01-13T14:50:28.305Z","etag":null,"topics":["ctags","gitk","graphviz","uml"],"latest_commit_sha":null,"homepage":null,"language":"Python","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/stefandtw.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}},"created_at":"2020-01-12T15:16:53.000Z","updated_at":"2024-11-04T13:04:38.000Z","dependencies_parsed_at":"2022-09-10T01:50:16.625Z","dependency_job_id":null,"html_url":"https://github.com/stefandtw/gitk-class-diagram","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/stefandtw/gitk-class-diagram","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stefandtw%2Fgitk-class-diagram","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stefandtw%2Fgitk-class-diagram/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stefandtw%2Fgitk-class-diagram/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stefandtw%2Fgitk-class-diagram/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stefandtw","download_url":"https://codeload.github.com/stefandtw/gitk-class-diagram/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stefandtw%2Fgitk-class-diagram/sbom","scorecard":{"id":850382,"data":{"date":"2025-08-11","repo":{"name":"github.com/stefandtw/gitk-class-diagram","commit":"26025e2dd773821587606620114ccf6b30757928"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":0,"reason":"Found 0/18 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: GNU General Public License v3.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-23T22:21:24.156Z","repository_id":57434678,"created_at":"2025-08-23T22:21:24.156Z","updated_at":"2025-08-23T22:21:24.156Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28414712,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T08:38:59.149Z","status":"ssl_error","status_checked_at":"2026-01-14T08:38:43.588Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["ctags","gitk","graphviz","uml"],"created_at":"2025-11-13T08:00:38.111Z","updated_at":"2026-01-14T08:53:20.873Z","avatar_url":"https://github.com/stefandtw.png","language":"Python","funding_links":[],"categories":["Content"],"sub_categories":["Generators and Translators"],"readme":"gitk-class-diagram\n==================\n\nExtends gitk to show a class diagram based on all files that were modified in a given commit, highlighting any changes.\n\n![java](https://user-images.githubusercontent.com/1097029/72220334-f22dd580-354f-11ea-8f14-5f70c065972e.png)*gitk showing some Java classes from [mockito](https://github.com/mockito/mockito)*\n\n![c](https://user-images.githubusercontent.com/1097029/72220351-1984a280-3550-11ea-9e0c-552da0af854e.png)*C may not have classes, but putting together structs, enums, and functions per file can still make a useful diagram ([htop](https://github.com/hishamhm/htop))*\n\n![python](https://user-images.githubusercontent.com/1097029/72220353-230e0a80-3550-11ea-8ede-8215c55ae474.png)*Python: comparing two minor releases of [flake8](https://gitlab.com/pycqa/flake8)*\n\nUsage\n-----\n\n* Whenever you select a commit, a class diagram is created and displayed on the bottom right\n* The diagram can also span multiple commits if you compare two revisions\n* If you exclude files with gitk's filter, they will not appear in the diagram either\n\nInteraction\n-----------\n\n* Left-click on a class to scroll to its file in gitk's diff view\n* Left-click on any text in the diagram to search for it in gitk's diff view\n* Options if the image is too big:\n  * Use the mouse wheel to zoom out\n  * Hold the left mouse button to move around\n  * Right-click and select \"Open PNG\"\n\nVisual aspects\n--------------\n\n* Red background indicates a removed file, class, attribute, operation, relationship\n* Green background indicates an added file, class, attribute, operation, relationship\n* Light blue background indicates a changed operation\n* A dashed border indicates that the element is not a real class, but rather the global scope of a file\n* If a file contains multiple classes, they are clustered within a dotted border\n* A blue border indicates the file that is currently shown in gitk's diff view\n\nLanguage support\n----------------\n\nHow well a language works depends on its support in universal-ctags. See:\n\n```\nctags --list-languages\nctags --list-kinds-full=\u003clanguage\u003e\n```\n\nList of what is recognized in popular languages:\n\n* **Python** — classes, functions, inheritance, function body changes, references to imported files and classes\n* **Java** — classes, functions, inheritance, function body changes, references to imported classes of other packages\n* **C** — structs, functions, attribute types, function body changes, references to included files\n* **Ruby** — classes, functions\n* **JavaScript** — classes, functions\n* **C++** — most classes are not recognized (ctags provides tags, but gitk-class-diagram does not handle them well enough)\n* **Go** — structs, functions, attribute types\n\nHow to get more associations between classes\n--------------------------------------------\n\nPut a file like [classref.ctags](doc/classref.ctags) in *$HOME/.ctags.d/* to produce associations based on regular expressions. The example file will instruct ctags to record any words in Java source code starting with an upper-case letter (and containing lower-case letters). These words will automatically be interpreted as references to other classes. This works pretty well with some languages. Of course, it's not as reliable as a parser that understands the language. It's also slower.\n\nHow to add your own language\n----------------------------\n\nUse ctags' optlib and create the tag kinds `class`, `field` and `function`.\n\nInstallation\n------------\n\n```\npip install gitk-class-diagram\n```\n\nYour existing gitk binary remains as it is. Start the extended version with:\n\n```\ngitk-cl\n```\n\nDependencies\n------------\n\n* [graphviz](https://www.graphviz.org/)\n* [universal-ctags](https://ctags.io/)\n* python \u003e= 3.7\n\nIf you are on Windows, make sure that graphviz, python and ctags are in your PATH.\n\nConfiguration\n-------------\n\nOpen gitk's preferences dialog. At the bottom there is an input field which accepts python code. Copy any settings from [config.py](classdiff/config.py) in there and change the values.\n\nUnfortunately, due to gitk's saving mechanism, the configuration is lost every time you start the original gitk without the extension.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstefandtw%2Fgitk-class-diagram","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstefandtw%2Fgitk-class-diagram","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstefandtw%2Fgitk-class-diagram/lists"}