snim2 / grep-repos

Gather information from all GitHub repos in an organisation and write them to a CSV file

grep-repos

Generate a CSV file of information about a set of GitHub repositories.

Getting started

Install dependencies:

./script/bootstrap

Add these lines to your ~/.zshrc or similar:

eval "$(pyenv init -)"
eval "$(pyenv virtualenv-init -)"

The Python virtualenv that the script/bootstrap script created will then be automatically activated and deactivated whenever you enter/leave the root of the repository.

Linting the code

Run:

./script/test

to run a standard set of lints over the code here.

Installing Git hooks

This repository contains a Git pre-commit hook that runs shellcheck over the shell scripts and calls ./script/test. To install the Git hook, run:

./script/install-git-hooks

Running the script

To run the script, you first need to create a personal access token.

Assuming that token is stored in a file called API_KEY, you can run the script like this:

python -m greprepos.greprepos --apikey=$(cat API_KEY) --org="ORGANISATION_NAME"