kelhaji / geit Goto Github PK

🐐 Geit provides contribution insights on software group projects that use Git

License: MIT License

Python 100.00%

git edu insights statistics git-educational-insights analysis actionable-insights education git-statistics teaching-tool

geit's People

Contributors

Stargazers

Watchers

Forkers

ar4s-eth

geit's Issues

Add ability to merge user emails

Error while writing output html

on ubuntu 20.20 with a fresh geit install get this error while attempting generation:

Collecting and analyzing contribution data...
Collecting and generating commits and contribution matrices...
Writing HTML output...
Traceback (most recent call last):
  File "/usr/lib/python3.8/sre_parse.py", line 1039, in parse_template
    this = chr(ESCAPES[this][1])
KeyError: '\\u'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "geit.py", line 135, in <module>
    handle_cli()
  File "/usr/lib/python3/dist-packages/click/core.py", line 764, in __call__
    return self.main(*args, **kwargs)
  File "/usr/lib/python3/dist-packages/click/core.py", line 717, in main
    rv = self.invoke(ctx)
  File "/usr/lib/python3/dist-packages/click/core.py", line 956, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/usr/lib/python3/dist-packages/click/core.py", line 555, in invoke
    return callback(*args, **kwargs)
  File "geit.py", line 89, in handle_cli
    filename = write_html_output(json_physical_data, identifier)
  File "geit.py", line 117, in write_html_output
    updated_file = re.sub(r'<script tag="data-entry-tag">.*<\/script>',
  File "/usr/lib/python3.8/re.py", line 208, in sub
    return _compile(pattern, flags).sub(repl, string, count)
  File "/usr/lib/python3.8/re.py", line 325, in _subx
    template = _compile_repl(template, pattern)
  File "/usr/lib/python3.8/re.py", line 316, in _compile_repl
    return sre_parse.parse_template(repl, pattern)
  File "/usr/lib/python3.8/sre_parse.py", line 1042, in parse_template
    raise s.error('bad escape %s' % this, len(this))
re.error: bad escape \u at position 444928

pip version: pip 20.0.2 from /usr/lib/python3/dist-packages/pip (python 3.8)

Filter Contributors

I want to remove the developers in the project and get statistical data

Lacking tests

Well, obvious... Specifically critical parts in which data is "scraped" from git repository should be tested for correctness.

Add log comments

Would be useful for the user and debugging.

Resolve bundle.js too large

Bundle.js currently 10.9mb! Way too large, figure out why and reduce it.

Add Windows support

See title. No windows support currently.

Resolve missing file in HEAD bug

Errors of this form:

Traceback (most recent call last):
  File "app.py", line 71, in <module>
    handle_cli()
  File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/click/core.py", line 764, in __call__
    return self.main(*args, **kwargs)
  File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/click/core.py", line 717, in main
    rv = self.invoke(ctx)
  File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/click/core.py", line 956, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/click/core.py", line 555, in invoke
    return callback(*args, **kwargs)
  File "app.py", line 32, in handle_cli
    "tree": physical_project.get_all_contributions(),
  File "/Users/khalid/geit/src/physical/project.py", line 264, in get_all_contributions
    for (email, line) in contributors:
  File "/Users/khalid/geit/src/physical/project.py", line 222, in __yield_file_contributions
    '--show-email').split('\n')
  File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/git/cmd.py", line 548, in <lambda>
    return lambda *args, **kwargs: self._call_process(name, *args, **kwargs)
  File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/git/cmd.py", line 1014, in _call_process
    return self.execute(call, **exec_kwargs)
  File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/git/cmd.py", line 825, in execute
    raise GitCommandError(command, status, stderr_value, stdout_value)
git.exc.GitCommandError: Cmd('git') failed due to: exit code(128)
  cmdline: git annotate ./root/tpl/zaak_v1/nl_NL/form/debilt/Images/logo.gif -M -C --minimal --show-email
  stderr: 'fatal: no such path 'root/tpl/zaak_v1/nl_NL/form/debilt/Images/logo.gif' in HEAD'

Occur at an unknown frequencies.

Date Filter

I want to pass statistical data through date filter

Commit distribution has broken labels when it display many days

Example:

Consider removing upper bound on amount of committers

The upper bound acts as a needless limitation of the tool.

Some committers are shown as not.committed.yet

In many of the repos I try to get the statistics, I get not.committed.yet as an author, in this case there is people in the repo but only 1 is shown in the HTML.

It doesn't ignore node_modules despite it being in git_ignore. It goes through every single file and gives this message:
Failed to find contributors to blah blah blah in git repository. The file is ignored.

Add support for VHDL files.

See title. Files like '.vhd', '.vhdl', '.v'

Resolve bugs related too having many contributors

As soon as a project has too many contributors it will result in graphs and tables looking squished.

Include explanation for all statistics and "Need Attention" label

Add plain Git support

Shouldn't be too difficult. We would simply exclude merge and issue data.

Simplify installation

Considering adding it to pip

Show commit distribution by user in overall commit distribution

Each bar would would be stacked with proportionate bar height to the respective commit count per contributor. Similar to the Contribution Types chart.

HTML output is empty on Windows when using Git Bash

When running the script the .html output doesn't properly render the report and fails because of an Unicode parsing error. Further investigation needed, for now don't run the script in Git Bash on Windows when wanting a HTML output.

Add GitHub support

Currently only GitLab is supported.

Add missing dependency

gitdb2==3.0.1 is needed as a result of GitPython not properly updating their shit.

Improve size .html output

Currently, 1 MB going only for a bunch of charts and tables. That should be way improved.