This code get the top 50 repos (based on the quantity of stars) from gitmostwanted and make the followings findings :
- License: Does the repository have a defined license?
- Activity: How many open issues created more than 30 days ago does this repository have? (The fewer, the better)
- Security: How many open pull requests containing the word "security" does this repository have? (The fewer, the better)
- Updated: How many open pull requests containing the word "bump" does this repository have? (The fewer, the better)
- Engagement: How many developers have committed code in the past 30 days?
- All commands are described on
Makefile
. - to install make, run
apt-get update && apt-get install gcc g++ make
. - Run
make help
to get all available commands.
To run this project, follow the next steps :
- Clone this repository.
- Create a oauth_token
and put it on .env.example file and run
make copy-envs
. - Build docker image :
make build
- Run the ingestion script:
make ingest
- Run the processing script with the result of the last script:
make process f=<heimdall ingestion file>