Tool for analysis and visualization of git logs
Visulog is a data visualisation tool lets you create grahics from a given repository's commit history.
| Operating System | Command | Notes |
|---|---|---|
| MacOS (Intel) | ||
| MacOS (arm) | ||
| Linux | ||
| Windows |
It can give analysis based on:
- number of lines added/deleted/changed
- number of character added/deleted/changed
- number of commits
- number of merge commits
It can visualise above analysis
- in charts which saved as png files
- on a web server
From the root of the project run the following command:
gradle build| Module | Description | Status | Version |
|---|---|---|---|
| analyzer | Create analysis with given parameters. These analysis are used on webgen and chartbuilder modules |
RELEASED | 0.0.1 |
| charbuilder | Contains all logic for building charts which will be saved as .png files on the local machine |
RELEASED | 0.0.1 |
| cli | Contains the source code of the Command Line Interface | RELEASED | 0.0.1 |
| config | Contains the configuration and the runner for the visulog. | RELEASED | 0.0.1 |
| git | The adapter for git | RELEASED | 0.0.1 |
| hq | The Mercurial adapter | TBD | 0.1.1 |
| github | The adapter for Github API | TBD | 0.0.2 |
| gitlab | The adapter for the Gitlab API | TBD | 0.0.3 |
| pluginmanager | Contains the core types for all plugins | RELEASED | 0.0.1 |
| webgen | Contains all the logic for web based visualisation of the analysis results | RELEASED | 0.0.1 |
| gui | Contains the source code of the graphical user interface | TBD | 0.1.2 |
| tablebuilder | Contains the source code and logic for building tables to show on stdout | RELEASED | 0.0.1 |
| csvbuilder | Contains all source code and logic for generating CSV files | RELEASED | 0.0.1 |
The feature requests triage is done in three priority levels
Features to implement in next releases
- Get commit history from a Github remote repository without cloning the entire repository
- Get commits from a remote repository with ssh without cloning
- Get commits from a remote repository with http without cloning
- Introduce a new module called
vcswhich will be parent ofgitandhqmodules. - Solve dependency problem: Modules importing another module can not access to the dependencies of the imported one.
- Introduce CLI only features
Features will be released once all P1 features are implemented
- Get commit history Gitlab remote repository without cloning the entire repository
- Graphical user interface (GUI)
Features to release after P2
- Add Mercurial support
- Add Bitbucket support
Features to define priorities following community needs
- Add tag support
All contributions are welcome. Please check existing issues to find ideas on what to contribute. If you can not find the issue fits your needs/desires, please create a new issue before diving on implementation to discuss about it.