github-manager icon indicating copy to clipboard operation
github-manager copied to clipboard

Generate repository, repositories (organizaiton\user) report on CLI

Open charithsoori opened this issue 9 years ago • 16 comments

  • number of commits
  • number of pull requests
  • number of issues opened and closed

We should probably look for an existing report generating project and integrate it here .

charithsoori avatar Oct 24 '16 06:10 charithsoori

👍 Some features I would love to see here:

  • Punch card image
  • Language map image
  • Total LOC added and removed

rehrumesh avatar Oct 25 '16 06:10 rehrumesh

Do you have suggestions for any existing libraries we can use for ?

charithsoori avatar Oct 25 '16 06:10 charithsoori

Another suggestion is to let user to customize the output. For example, say a particular org admin wants a report with only punch card and pull requests, he should be able to generate the report with only these information instead of the full report.

rehrumesh avatar Oct 25 '16 06:10 rehrumesh

Is it correct that you would like to have an HTML report for CLI application? What about small CLI report(probably with some ASCII art)?

G07cha avatar Oct 25 '16 08:10 G07cha

Yes I think having a HTML report will be nice and useful . But then again you are right may be as the initial stage we can print it to CLI and then extend that functionality to a HTML report

charithsoori avatar Oct 25 '16 08:10 charithsoori

@charithsoori, I'm just thinking that GitHub itself already have HTML reports. So GitHub-CLI basically will do the same thing in the same environment. But maybe you have ideas about other types of reports that is not presented in GitHub?

G07cha avatar Oct 25 '16 08:10 G07cha

@G07cha Do you have any reference link to report for open source repository and org by GitHub itself ? Could find a one other than audit log .

charithsoori avatar Oct 25 '16 08:10 charithsoori

I meant that current repository statistic provided by GitHub could be previewed and easily saved. According to @rehrumesh suggestion I thought that github-cli trying to achieve the same result.

G07cha avatar Oct 25 '16 08:10 G07cha

Ahh I got it . Yes they provide a really nice report for an individual repository .

  • But here we are kind of keeping the objective as managing multiple repositories or an organization at once . So an individual report for multiple repositories provided .
  • I agree with your idea on going with a CLI . That will give us a base ground to build on for anything

So lets go with small CLI report(probably with some ASCII art) as you suggested :)

charithsoori avatar Oct 25 '16 08:10 charithsoori

Sorry if I've incorrectly described my thoughts(trying to master my English but it's far from good level right now). I agree with the fact that organization/user doesn't have an individual report, this might be a nice feature to have.

G07cha avatar Oct 25 '16 09:10 G07cha

Your discussion enabled me to see this in a different point of view . Thank you for it :) .

As you suggested we can create a base CLI feature first and later work towards to an interactive report using HTML or ... Probably we can break this into to two tasks . Ill do it now

charithsoori avatar Oct 25 '16 09:10 charithsoori

👍 two tasks seems to be ok here. @G07cha thanks for suggesting CLI option

rehrumesh avatar Oct 25 '16 09:10 rehrumesh

created task #29 :)

charithsoori avatar Oct 25 '16 09:10 charithsoori

@G07cha Are you still working on this task ?

charithsoori avatar Oct 28 '16 09:10 charithsoori

Ehm, I'm not even planned to do this yet, just shared my thoughts according to this topic.

G07cha avatar Oct 28 '16 09:10 G07cha

nice 👍 Open task is open for anyone interested

charithsoori avatar Oct 28 '16 09:10 charithsoori