Hector

A code quality & coverage analytics toolkit.

✨ FOSS, self hosted, self managed alternative to codecov, codeclimate, codefactor & similar services.

• Lightweight, stateless CI pipeline integration
• PR comments with coverage & code health reports

Installation

pip install git+https://github.com/tata1mg/hector.git

Usage

Simply type hector in your terminal for all the options

$ hector

Add following steps to your bitbucket pipeline

Run your test suite & generate coverage report

$ coverage run pytest .

Generate coverage.json (required for parsable coverage stats) & coverage.xml (required by hector diff report)

$ coverage json
$ coverage xml

Run hector inside the bitbucket pipeline to post a comment

$ hector report

Roadmap

👩🏼‍💻 Core

• Add cli commands for all operations, using Typer
• Use Pydantic models for parsing reports
• Use httpx for http clients
• Refactor for dependency inversion

✨ Features

• Bundle diff-cover
• Add support for Code health metrics
• Bundle radon

👾 Bots

• Bitbucket PR comments
• Github PR comments
• Flock reports
• Discord reports
• Slack reports

🔧 Integrations

• Bitbucket Pipe
• Github Actions
• Github App

🚀 Deployment

• Support serving a Sanic application
• Support serving a FastAPI application
• Support deployment as an AWS Lambda

Maintainers

dollar-1mg	0xlakshay

Contributing

Contributions are always welcome!

Please read our contribution guidelines and code of conduct to get started.

License

MIT