Merge pull request #112 from casperdcl/svg

Author: casperdcl

README.rst

@@ -9,9 +9,18 @@ Pretty-print ``git`` repository collaborators sorted by contributions.
 
 |DOI-URI| |LICENCE| |OpenHub-Status| |Sponsor-Casper|
 
+.. code::
+
+    https://git-fame.cdcl.ml/gh/{owner}/{repo}
+
+|Contributions|
+
+.. code:: sh
+
+    git fame --cost hour,month --loc ins
+
 .. code:: sh
 
-    ~$ git fame --cost hour,month --loc ins
     Processing: 100%|██████████████████████████| 1/1 [00:00<00:00,  2.16repo/s]
     Total commits: 1775
     Total ctimes: 2770
@@ -116,7 +125,7 @@ Tab completion
 
 Optionally, systems with ``bash-completion`` can install tab completion
 support. The
-`git-fame_completion.bash <https://raw.githubusercontent.com/casperdcl/git-fame/main/git-fame_completion.bash>`__
+`git-fame_completion.bash <https://raw.githubusercontent.com/casperdcl/git-fame/main/git-fame_completion.bash>`_
 file needs to be copied to an appropriate folder.
 
 On Ubuntu, the procedure would be:
@@ -137,7 +146,7 @@ followed by a terminal restart.
 Changelog
 ---------
 
-The list of all changes is available on the Releases page: |GitHub-Status|.
+The list of all changes is available on the Releases page: |GitHub-Status|
 
 
 Usage
@@ -165,12 +174,14 @@ It is also possible to run from within a python shell or script.
     >>> import gitfame
     >>> gitfame.main(['--sort=commits', '-wt', '/path/to/my/repo'])
 
+Finally, there is a live server for public GitHub repositories at `git-fame.cdcl.ml/gh/{owner}/{repo} <https://git-fame.cdcl.ml/docs>`_.
+
+The ``rendered by git-fame.cdcl.ml`` watermark is removed for sponsors of `casperdcl <https://github.com/casperdcl>`_: |Sponsor-Casper|
+
 
 Documentation
 -------------
 
-|Py-Versions| |README-Hits|
-
 .. code::
 
     Usage:
@@ -186,6 +197,7 @@ Documentation
       -v, --version  Print module version and exit.
       --branch=<b>   Branch or tag [default: HEAD] up to which to check.
       --sort=<key>   [default: loc]|commits|files|hours|months.
+      --min=<val>    Minimum value (of `--sort` key) to show [default: 0:int].
       --loc=<type>   surv(iving)|ins(ertions)|del(etions)
                      What `loc` represents. Use 'ins,del' to count both.
                      defaults to 'surviving' unless `--cost` is specified.
@@ -224,7 +236,7 @@ Documentation
       --ignore-revs-file=<f>   Ignore revisions listed in the given file
                                (requires `--loc=surviving`).
       --format=<format>        Table format
-          [default: pipe]|md|markdown|yaml|yml|json|csv|tsv|tabulate.
+          svg|[default: pipe]|md|markdown|yaml|yml|json|csv|tsv|tabulate.
           May require `git-fame[<format>]`, e.g. `pip install git-fame[yaml]`.
           Any `tabulate.tabulate_formats` is also accepted.
       --manpath=<path>         Directory in which to install git-fame man pages.
@@ -257,14 +269,30 @@ In such cases, ``--excl`` may need to be significantly extended.
 On the plus side, it is faster to compute ``ins`` and ``del`` compared to
 ``surv``.
 
+
 Examples
 --------
 
+Badges
+~~~~~~
+
+An SVG image for inclusion in README files and websites:
+
+.. code:: sh
+
+   git fame -wMC --format svg --min 1 > docs/authors.svg
+
+Which can also be dynamically created for public GitHub repositories:
+
+.. code:: md
+
+   ![markdown-image](https://git-fame.cdcl.ml/gh/{owner}/{repo}?min=1)
+
 CODEOWNERS
 ~~~~~~~~~~
 
 Generating
-`CODEOWNERS <https://help.github.com/en/articles/about-code-owners>`__:
+`CODEOWNERS <https://help.github.com/en/articles/about-code-owners>`_:
 
 .. code:: sh
 
@@ -292,7 +320,7 @@ Generating
 Zenodo config
 ~~~~~~~~~~~~~
 
-Generating `.zenodo.json <https://developers.zenodo.org/#deposit-metadata>`__:
+Generating `.zenodo.json <https://developers.zenodo.org/#deposit-metadata>`_:
 
 .. code:: sh
 
@@ -301,14 +329,18 @@ Generating `.zenodo.json <https://developers.zenodo.org/#deposit-metadata>`__:
       | sed -r -e 's/(\{"name")/\n    \1/g' -e 's/:/: /g' \
       > .zenodo.json
 
+
 Contributions
 -------------
 
 |GitHub-Commits| |GitHub-Issues| |GitHub-PRs| |OpenHub-Status|
 
-All source code is hosted on `GitHub <https://github.com/casperdcl/git-fame>`__.
+All source code is hosted on `GitHub <https://github.com/casperdcl/git-fame>`_.
 Contributions are welcome.
 
+|Contributions|
+
+The ``rendered by git-fame.cdcl.ml`` watermark is removed for sponsors of `casperdcl <https://github.com/casperdcl>`_: |Sponsor-Casper|
 
 LICENCE
 -------
@@ -317,16 +349,6 @@ Open Source (OSI approved): |LICENCE|
 
 Citation information: |DOI-URI|
 
-
-Authors
--------
-
-|OpenHub-Status|
-
-- Casper da Costa-Luis (`casperdcl <https://github.com/casperdcl>`__ |Sponsor-Casper|)
-
-We are grateful for all |GitHub-Contributions|.
-
 |README-Hits|
 
 .. |Build-Status| image:: https://img.shields.io/github/actions/workflow/status/casperdcl/git-fame/test.yml?branch=main&label=git-fame&logo=GitHub
@@ -349,8 +371,8 @@ We are grateful for all |GitHub-Contributions|.
    :target: https://github.com/casperdcl/git-fame/issues
 .. |GitHub-PRs| image:: https://img.shields.io/github/issues-pr-closed/casperdcl/git-fame.svg?logo=github
    :target: https://github.com/casperdcl/git-fame/pulls
-.. |GitHub-Contributions| image:: https://img.shields.io/github/contributors/casperdcl/git-fame.svg?logo=github
-   :target: https://github.com/casperdcl/git-fame/graphs/contributors
+.. |Contributions| image:: https://git-fame.cdcl.ml/gh/casperdcl/git-fame
+   :target: https://git-fame.cdcl.ml/gh/casperdcl/git-fame
 .. |GitHub-Updated| image:: https://img.shields.io/github/last-commit/casperdcl/git-fame?label=pushed&logo=github
    :target: https://github.com/casperdcl/git-fame/pulse
 .. |Sponsor-Casper| image:: https://img.shields.io/badge/sponsor-FOSS-dc10ff.svg?logo=Contactless%20Payment

git-fame_completion.bash

@@ -16,10 +16,13 @@ _git_fame()
           COMPREPLY=($(compgen -W 'months cocomo hours commits' -- ${cur}))
           ;;
         --loc)
-          COMPREPLY=($(compgen -W 'surviving insertions deletions' -- ${cur}))
+          COMPREPLY=($(compgen -W 'surviving insertions deletions ins,del' -- ${cur}))
           ;;
         --format)
-          COMPREPLY=($(compgen -W 'pipe markdown yaml json csv tsv tabulate' -- ${cur}))
+          COMPREPLY=($(compgen -W 'pipe markdown yaml json csv tsv svg tabulate' -- ${cur}))
+          ;;
+        --show)
+          COMPREPLY=($(compgen -W 'name email name,email' -- ${cur}))
           ;;
         --log)
           COMPREPLY=($(compgen -W 'FATAL CRITICAL ERROR WARNING INFO DEBUG NOTSET' -- ${cur}))
@@ -33,12 +36,12 @@ _git_fame()
         --manpath)
           COMPREPLY=($(compgen -d -- "${cur}"))
           ;;
-        --incl|--excl|--since|--ignore-rev|--until)
+        --incl|--excl|--since|--ignore-rev|--until|--min)
           COMPREPLY=( )
           ;;
         *)
           if [ ${COMP_WORDS[1]} == fame ]; then
-            COMPREPLY=($(compgen -dW '-h --help -v --version --cost --branch --since --until --sort --loc --incl --excl -R --recurse -n --no-regex -s --silent-progress --warn-binary -t --bytype -w --ignore-whitespace -e --show-email --enum -M -C --ignore-rev --ignore-revs-file --format --manpath --log' -- ${cur}))
+            COMPREPLY=($(compgen -dW '-h --help -v --version --cost --branch --since --until --sort --loc --incl --excl -R --recurse -n --no-regex -s --silent-progress --warn-binary -t --bytype -w --ignore-whitespace --show -e --show-email --enum -M -C --ignore-rev --ignore-revs-file --format --manpath --log' -- ${cur}))
           fi
           ;;
       esac

gitfame/_gitfame.py

@@ -12,6 +12,7 @@
   -v, --version  Print module version and exit.
   --branch=<b>   Branch or tag [default: HEAD] up to which to check.
   --sort=<key>   [default: loc]|commits|files|hours|months.
+  --min=<val>    Minimum value (of `--sort` key) to show [default: 0:int].
   --loc=<type>   surv(iving)|ins(ertions)|del(etions)
                  What `loc` represents. Use 'ins,del' to count both.
                  defaults to 'surviving' unless `--cost` is specified.
@@ -50,7 +51,7 @@
   --ignore-revs-file=<f>   Ignore revisions listed in the given file
                            (requires `--loc=surviving`).
   --format=<format>        Table format
-      [default: pipe]|md|markdown|yaml|yml|json|csv|tsv|tabulate.
+      svg|[default: pipe]|md|markdown|yaml|yml|json|csv|tsv|tabulate.
       May require `git-fame[<format>]`, e.g. `pip install git-fame[yaml]`.
       Any `tabulate.tabulate_formats` is also accepted.
   --manpath=<path>         Directory in which to install git-fame man pages.
@@ -123,7 +124,7 @@ def hours(dates, maxCommitDiffInSec=120 * 60, firstCommitAdditionInMinutes=120):
 
 
 def tabulate(auth_stats, stats_tot, sort='loc', bytype=False, backend='md', cost=None,
-             row_nums=False, width=TERM_WIDTH):
+             row_nums=False, min_sort_val=0, width=TERM_WIDTH):
     """
     backends  : [default: md]|yaml|json|csv|tsv|tabulate|
       `in tabulate.tabulate_formats`
@@ -154,6 +155,8 @@ def tabulate(auth_stats, stats_tot, sort='loc', bytype=False, backend='md', cost
 
     for i, j in (("commits", "coms"), ("files", "fils"), ("hours", "hrs"), ("months", "mths")):
         sort = sort.replace(i, j)
+    if min_sort_val:
+        tab = [i for i in tab if i[COL_NAMES.index(sort)] >= min_sort_val]
     tab.sort(key=lambda i: i[COL_NAMES.index(sort)], reverse=True)
     if row_nums:
         tab = [[str(i)] + j for i, j in enumerate(tab, 1)]
@@ -163,6 +166,9 @@ def tabulate(auth_stats, stats_tot, sort='loc', bytype=False, backend='md', cost
 
     if (backend := backend.lower()) in ("tabulate", "md", "markdown"):
         backend = "pipe"
+    svg = backend == 'svg'
+    if svg:
+        backend = 'rounded_outline'
 
     if backend in ('yaml', 'yml', 'json', 'csv', 'tsv'):
         tab = [i[:-1] + [float(pc.strip()) for pc in i[-1].split('/')] for i in tab]
@@ -194,13 +200,25 @@ def tabulate(auth_stats, stats_tot, sort='loc', bytype=False, backend='md', cost
             raise RuntimeError("Should be unreachable")
     else:
         import tabulate as tabber
+
         if backend not in tabber.tabulate_formats:
             raise ValueError(f"Unknown backend:{backend}")
         log.debug("backend:tabulate:%s", backend)
         COL_LENS = [max(len(Str(i[j])) for i in [COL_NAMES] + tab) for j in range(len(COL_NAMES))]
         COL_LENS[0] = min(width - sum(COL_LENS[1:]) - len(COL_LENS) * 3 - 4, COL_LENS[0])
         tab = [[i[0][:COL_LENS[0]]] + i[1:] for i in tab]
-        return totals + tabber.tabulate(tab, COL_NAMES, tablefmt=backend, floatfmt='.0f')
+        table = tabber.tabulate(tab, COL_NAMES, tablefmt=backend, floatfmt='.0f')
+        if svg:
+            rows = table.split('\n')
+            return ('<svg xmlns="http://www.w3.org/2000/svg"'
+                    f' width="{len(rows[0]) / 2 + 1}em" height="{len(rows)}em">'
+                    '<rect x="0" y="0" width="100%" height="100%"'
+                    ' fill="white" fill-opacity="0.5" rx="5"/>'
+                    '<text x="0" y="-0.5em" font-size="15"'
+                    ' font-family="monospace" style="white-space: pre">' +
+                    ''.join(f'<tspan x="0" dy="1em">{row}</tspan>'
+                            for row in rows) + '</text></svg>')
+        return totals + table
 
         # from ._utils import tighten
         # return totals + tighten(tabber(...), max_width=TERM_WIDTH)
@@ -467,7 +485,8 @@ def run(args):
     # log.debug(extns)
 
     print_unicode(
-        tabulate(auth_stats, stats_tot, args.sort, args.bytype, args.format, cost, args.enum))
+        tabulate(auth_stats, stats_tot, args.sort, args.bytype, args.format, cost, args.enum,
+                 args.min))
 
 
 def get_main_parser():

gitfame/git-fame.1

@@ -41,6 +41,9 @@ Branch or tag [default: HEAD] up to which to check.
 \-\-sort=\f[I]key\f[R]
 [default: loc]|commits|files|hours|months.
 .TP
+\-\-min=\f[I]val\f[R]
+Minimum value (of \f[CR]\-\-sort\f[R] key) to show [default: 0:int].
+.TP
 \-\-loc=\f[I]type\f[R]
 surv(iving)|ins(ertions)|del(etions) What \f[CR]loc\f[R] represents.
 Use `ins,del' to count both.
@@ -118,7 +121,8 @@ Ignore revisions listed in the given file (requires
 \f[CR]\-\-loc=surviving\f[R]).
 .TP
 \-\-format=\f[I]format\f[R]
-Table format [default: pipe]|md|markdown|yaml|yml|json|csv|tsv|tabulate.
+Table format svg|[default:
+pipe]|md|markdown|yaml|yml|json|csv|tsv|tabulate.
 May require \f[CR]git\-fame[<format>]\f[R],
 e.g.\ \f[CR]pip install git\-fame[yaml]\f[R].
 Any \f[CR]tabulate.tabulate_formats\f[R] is also accepted.

snapcraft.yaml

@@ -4,7 +4,7 @@ description: https://github.com/casperdcl/git-fame
 adopt-info: git-fame
 grade: stable
 confinement: strict
-base: core22
+base: core24
 license: MPL-2.0
 parts:
   git-fame:

tests/tests_gitfame.py

@@ -40,6 +40,8 @@ def test_tabulate():
     | Casper da Costa-Luis |   538 |     35 |     10 | 87.8/ 100/71.4  |
     | Not Committed Yet    |    75 |      0 |      4 | 12.2/ 0.0/28.6  |"""))
 
+    assert "Not Committed Yet" not in _gitfame.tabulate(auth_stats, stats_tot, min_sort_val=76)
+
 
 def test_tabulate_cost():
     """Test cost estimates"""
@@ -160,7 +162,7 @@ def test_tabulate_unknown():
     [['--sort', 'commits'], ['--no-regex'], ['--no-regex', '--incl', 'setup.py,README.rst'],
      ['--excl', r'.*\.py'], ['--loc', 'ins,del'], ['--cost', 'hour'], ['--cost', 'month'],
      ['--cost', 'month', '--excl', r'.*\.py'], ['-e'], ['-w'], ['-M'], ['-C'], ['-t'],
-     ['--show=name,email']])
+     ['--show=name,email'], ['--format=csv'], ['--format=svg']])
 def test_options(params):
     """Test command line options"""
     main(['-s'] + params)