Skip to content

Latest commit

 

History

History
30 lines (24 loc) · 1.1 KB

README.md

File metadata and controls

30 lines (24 loc) · 1.1 KB
Raw

gengee

A Gentoo Github PR analysis tool. Easily getting views on the open Gentoo pull requests that Github does not provide.

Installation

The setup.py will take care of dependencies except Portage; assuming this is installed. An ebuild is available in the flavour overlay.

Dependencies

  • Portage
  • PyGithub
  • prettytable
  • lxml

Config

Before use, a config file needs to be set up. You can use the included example config to create your oqn, and set, for example the "public_repo" Github personal access token. The file can be stored in 2 locations:

  • local/dev: in the cloned gengee directory
  • user: ~/.config/gengee/config.json

If using the local/dev setup, the database file will be saved there as well, otherwise in ~/.cache/gengee/config.json .

Usage

There are 2 commands:

  • gengee-update: to create a local json database
  • gengee-query: to execute different views, add -h to see all views, output to html by adding a -f html

todo

  • provide optional keywords for "small" search
  • some unit tests
  • perhaps better distinction between analysis and display of errors