README.md

pyrepositoryminer

The pyrepositoryminer aims to be a performant, extendable and useful tool for analyzing (large) software repositories.

Installation

Install it from PyPI:

$ pip install pyrepositoryminer

Requirements

Python 3.9+, libgit2 (e.g. brew install libgit2 on macOS).

pyrepositoryminer builds on the work of pygit2 for the interaction with git repository objects, typer for the CLI, radon for Python-specific metrics, and uvloop for an alternative event loop.

Contributing

Install poetry:

$ curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/install-poetry.py | python -

Install the dependencies:

$ poetry install

Install the pre-commit hooks:

$ pre-commit install