https://github.com/tata1mg/hector
A code quality & coverage analytics toolkit.
https://github.com/tata1mg/hector
bitbucket code-health coverage coverage-report diff-cover radon
Last synced: 5 months ago
JSON representation
A code quality & coverage analytics toolkit.
- Host: GitHub
- URL: https://github.com/tata1mg/hector
- Owner: tata1mg
- License: mit
- Created: 2024-01-16T12:40:58.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-09-22T11:40:52.000Z (9 months ago)
- Last Synced: 2025-09-22T12:15:54.130Z (9 months ago)
- Topics: bitbucket, code-health, coverage, coverage-report, diff-cover, radon
- Language: Python
- Homepage: https://tata1mg.github.io/hector/
- Size: 192 KB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Hector
A code quality & coverage analytics toolkit.
[](https://www.1mg.com/jobs)
✨ 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
```py
pip install git+https://github.com/tata1mg/hector.git
```
## Usage
Simply type hector in your terminal for all the options
```py
$ hector
```
**Add following steps to your bitbucket pipeline**
Run your test suite & generate coverage report
```py
$ coverage run pytest .
```
Generate `coverage.json` (required for parsable coverage stats)
& `coverage.xml` (required by hector diff report)
```py
$ coverage json
$ coverage xml
```
Run hector inside the bitbucket pipeline to post a comment
```py
$ hector report
```
## Roadmap
### 👩🏼💻 Core
- [x] Add cli commands for all operations, using `Typer`
- [ ] Use `Pydantic` models for parsing reports
- [ ] Use `httpx` for http clients
- [ ] Refactor for dependency inversion
### ✨ Features
- [x] Bundle `diff-cover`
- [ ] Add support for Code health metrics
- [ ] Bundle `radon`
### 👾 Bots
- [x] 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
## Contributing
Contributions are always welcome!
Please read our [`contribution guidelines`](./CHANGELOG.md) and [`code of conduct`](./CODE_OF_CONDUCT.md) to get started.
## License
[MIT](https://choosealicense.com/licenses/mit/)
