codemetrics 0.8.0

SCM mining utility classes

Code Metrics

Mine your SCM for insight on your software. A work of love inspired by Adam Tornhill’s books.

Code metrics is a simple Python module that leverage your source control management (SCM) tool to generate insight on your code base.

• pandas: for data munching.

• lizard: for code complexity calculation.

• cloc.pl (script): for line counts from cloc

• For now, only Subversion and git are supported.

Installation

To install codemetrics, simply use pip:

pip install codemetrics

Usage

This is a simple tool that makes it easy to retrieve information from your Source Control Management (SCM) repository and hopefully gain insight from it.

import codemetrics as cm
import cm.git

log_df = cm.git.get_git_log()
ages_df = cm.get_ages(log_df)

See module documentation for more advanced functions.

License

Licensed under the term of MIT License. See attached file LICENSE.txt.

Credits

• This package was inspired by Adam Tornhill’s books.

• This package was created with Cookiecutter.

History

0.8 (2019-02-13)

• Integrated lizard to calculate average and function level cyclomatic complexity.

0.7 (2019-01-09)

• Function oriented interface.

• Visualization via Vega, Altair.

• Documentation.

0.6

• Alpha work.

0.5 (2018-05-12)

• First release on PyPI.