Create contributors data gathering script

[mrmundt]

Fixes NA

Summary/Motivation:

This adds a small script that can assist with gathering relevant contributor information for a given repository during a given timeframe. It was requested as part of an IDAES technical meeting.

Changes proposed in this PR:

• New useful contributor script

Legal Acknowledgement

By contributing to this software project, I have read the contribution guide and agree to the following terms and conditions for my contribution:

1. I agree my contributions are submitted under the BSD license.
2. I represent I am authorized to make the contributions and grant the license. If my employer has rights to intellectual property that includes these contributions, I represent that I have received permission to make contributions and grant the required license on behalf of that employer.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (785501d) 86.03% compared to head (a34bbff) 88.29%.
Report is 5 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3117      +/-   ##
==========================================
+ Coverage   86.03%   88.29%   +2.26%     
==========================================
  Files         832      832              
  Lines       92243    92243              
==========================================
+ Hits        79360    81447    +2087     
+ Misses      12883    10796    -2087     

Flag	Coverage Δ
linux	86.05% <ø> (?)
osx	75.55% <ø> (ø)
other	86.23% <ø> (?)
win	83.45% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[mrmundt]

Output currently looks like this:

 COLLECTION COMPLETE. Time to completion: 110.5916 seconds

Contributors between 2023-08-23 and 2023-11-29:
{'Authors': {'Cody Karcher': 1,
             'Emma Johnson': 5,
             'Jason Sherman': 2,
             'John Siirola': 28,
             'Michael Bynum': 4,
             'Miranda Mundt': 8,
             'Raphael Donisete F. Gomes': 1,
             'Robert Parker': 3,
             'Zedong': 2,
             'hglynch': 1,
             'sadavis1': 1,
             'smartin71': 1},
 'Commits': {'Raphael-D-F-Gomes': 5,
             'Robbybp': 32,
             'ZedongPeng': 36,
             'blnicho': 29,
             'codykarcher': 41,
             'emma58': 78,
             'gomesraphael7d': 9,
             'hglynch': 4,
             'jsiirola': 232,
             'michaelbynum': 21,
             'mrmundt': 70,
             'sadavis1': 4,
             'shermanjasonaf': 93,
             'smartin71': 5},
 'Pull Requests': {2809: {'author': 'emma58',
                          'reviewers': {'bernalde',
                                        'emma58',
                                        'jsiirola',
                                        'mrmundt'}},
                   2887: {'author': 'ZedongPeng',
                          'reviewers': {'ZedongPeng',
                                        'bernalde',
                                        'emma58',
                                        'mrmundt'}},
                   2889: {'author': 'hglynch',
                          'reviewers': {'adowling2',
                                        'blnicho',
                                        'hglynch',
                                        'jsiirola',
                                        'mrmundt'}},
                   2902: {'author': 'michaelbynum', 'reviewers': {'blnicho'}},
                   2930: {'author': 'jsiirola',
                          'reviewers': {'Robbybp',
                                        'blnicho',
                                        'jsiirola',
                                        'mrmundt'}},
                   2932: {'author': 'sadavis1',
                          'reviewers': {'emma58', 'sadavis1'}},
                   2946: {'author': 'Raphael-D-F-Gomes',
                          'reviewers': {'mrmundt', 'jsiirola', 'blnicho'}},
                   2953: {'author': 'jsiirola',
                          'reviewers': {'mrmundt', 'blnicho'}},
                   2956: {'author': 'mrmundt',
                          'reviewers': {'jsiirola', 'blnicho'}},
                   2965: {'author': 'mrmundt', 'reviewers': {'jsiirola'}},
                   2966: {'author': 'jsiirola',
                          'reviewers': {'mrmundt', 'blnicho'}},
                   2967: {'author': 'jsiirola', 'reviewers': {'mrmundt'}},
                   2968: {'author': 'mrmundt', 'reviewers': {'blnicho'}},
                   2969: {'author': 'Robbybp',
                          'reviewers': {'mrmundt', 'jsiirola', 'blnicho'}},
                   2973: {'author': 'emma58',
                          'reviewers': {'emma58', 'jsiirola'}},
                   2975: {'author': 'jsiirola', 'reviewers': {'mrmundt'}},
                   2979: {'author': 'jsiirola',
                          'reviewers': {'mrmundt', 'andrewlee94'}},
                   2981: {'author': 'jsiirola',
                          'reviewers': {'mrmundt', 'blnicho'}},
                   2982: {'author': 'jsiirola',
                          'reviewers': {'mrmundt', 'blnicho'}},
                   2983: {'author': 'jsiirola',
                          'reviewers': {'mrmundt', 'blnicho'}},
                   2984: {'author': 'codykarcher',
                          'reviewers': {'blnicho',
                                        'codykarcher',
                                        'emma58',
                                        'jsiirola',
                                        'mrmundt'}},
                   2987: {'author': 'mrmundt', 'reviewers': {'blnicho'}},
                   2988: {'author': 'ZedongPeng',
                          'reviewers': {'ZedongPeng',
                                        'bernalde',
                                        'blnicho',
                                        'emma58',
                                        'michaelbynum'}},
                   2990: {'author': 'shermanjasonaf',
                          'reviewers': {'jsiirola',
                                        'mrmundt',
                                        'natalieisenberg'}},
                   2992: {'author': 'mrmundt', 'reviewers': {'blnicho'}},
                   2994: {'author': 'Robbybp',
                          'reviewers': {'Robbybp',
                                        'blnicho',
                                        'jsiirola',
                                        'michaelbynum'}},
                   2995: {'author': 'michaelbynum',
                          'reviewers': {'mrmundt', 'jsiirola'}},
                   2996: {'author': 'michaelbynum',
                          'reviewers': {'mrmundt', 'jsiirola', 'michaelbynum'}},
                   2997: {'author': 'jsiirola',
                          'reviewers': {'mrmundt', 'michaelbynum', 'jsiirola'}},
                   2998: {'author': 'jsiirola',
                          'reviewers': {'mrmundt', 'shermanjasonaf'}},
                   3001: {'author': 'jsiirola',
                          'reviewers': {'emma58', 'mrmundt'}},
                   3004: {'author': 'jsiirola',
                          'reviewers': {'jsiirola', 'blnicho'}},
                   3005: {'author': 'jsiirola', 'reviewers': {'michaelbynum'}},
                   3008: {'author': 'jsiirola',
                          'reviewers': {'emma58', 'mrmundt'}},
                   3009: {'author': 'emma58',
                          'reviewers': {'mrmundt', 'jsiirola'}},
                   3010: {'author': 'emma58', 'reviewers': {'blnicho'}},
                   3011: {'author': 'jsiirola',
                          'reviewers': {'emma58', 'jsiirola'}},
                   3013: {'author': 'jsiirola', 'reviewers': {'mrmundt'}},
                   3015: {'author': 'jsiirola',
                          'reviewers': {'emma58', 'mrmundt', 'jsiirola'}},
                   3017: {'author': 'jsiirola', 'reviewers': {'blnicho'}},
                   3018: {'author': 'jsiirola', 'reviewers': {'emma58'}},
                   3021: {'author': 'jsiirola', 'reviewers': {'mrmundt'}},
                   3023: {'author': 'michaelbynum',
                          'reviewers': {'michaelbynum', 'blnicho'}},
                   3025: {'author': 'jsiirola', 'reviewers': {'michaelbynum'}},
                   3026: {'author': 'jsiirola', 'reviewers': {'mrmundt'}},
                   3027: {'author': 'emma58',
                          'reviewers': {'emma58', 'michaelbynum', 'jsiirola'}},
                   3028: {'author': 'smartin71', 'reviewers': {'blnicho'}},
                   3033: {'author': 'mrmundt', 'reviewers': {'blnicho'}},
                   3035: {'author': 'shermanjasonaf',
                          'reviewers': {'jsiirola', 'blnicho'}},
                   3037: {'author': 'jsiirola',
                          'reviewers': {'michaelbynum', 'jsiirola'}},
                   3039: {'author': 'jsiirola',
                          'reviewers': {'mrmundt', 'blnicho'}},
                   3041: {'author': 'Robbybp',
                          'reviewers': {'jsiirola', 'blnicho'}},
                   3042: {'author': 'jsiirola', 'reviewers': {'mrmundt'}},
                   3043: {'author': 'jsiirola',
                          'reviewers': {'mrmundt', 'blnicho'}},
                   3046: {'author': 'jsiirola',
                          'reviewers': {'emma58', 'mrmundt', 'jsiirola'}},
                   3050: {'author': 'mrmundt',
                          'reviewers': {'jsiirola', 'blnicho'}},
                   3053: {'author': 'mrmundt',
                          'reviewers': {'michaelbynum', 'blnicho'}}},
 'Reviewers': {'Alex Dowling': 1,
               'Andrew Lee': 1,
               'Bethany Nicholson': 29,
               'Cody Karcher': 1,
               'David Bernal': 3,
               'Emma Johnson': 13,
               'Jason Sherman': 1,
               'John Siirola': 24,
               'Michael Bynum': 10,
               'Miranda Mundt': 31,
               'Natalie Isenberg': 1,
               'Robert Parker': 2,
               'Zedong': 2,
               'hglynch': 1,
               'sadavis1': 1}}

[ksbeattie]

This looks really good. One minor suggestion would be to have the default output be a simple list of names combining all authors, committers and reviewers, with option to show the above more detailed output if desired.

[jsiirola]

Please add the copyright header, then this should be good to merge.

[mrmundt]

Another note from @ksbeattie - a quick "README" or a more explanatory help message.

[mrmundt]

@ksbeattie - Please look over! The new output looks like this:

$ python scripts/admin/contributors.py IDAES/idaes-pse 2023-12-01 2024-02-01
BEGIN DATA COLLECTION... (this can take some time)

COLLECTION COMPLETE. Time to completion: 35.7895 seconds

Contributors between 2023-12-01 and 2024-02-01:
Ludovico Bianchi
Robert Parker
Andrew Lee
Dan Gunter
Alex Noring
Keith Beattie
Miranda Mundt
Bethany Nicholson
Brandon Paul

Only GitHub handles are available for the following contributors:
OOAmusat
dallan-keylogic
agarciadiego
MarcusHolly
bknueven
NishantGiridhar
ArkoprabhoDasgupta

Detailed information can be found in contributors-2023-12-01-2024-02-01.json.

[ksbeattie]

@ksbeattie - Please look over! The new output looks like this:

Looks great. I just tried it on IDAES/idaes-pse, watertap-org/watertap and CCSI-Toolset/FOQUS and it worked just fine.

Thank you so much!