Metadata-Version: 1.1
Name: git-fame
Version: 1.4.2
Summary: Pretty-print `git` repository collaborators sorted by contributions
Home-page: https://github.com/casperdcl/git-fame
Author: Casper da Costa-Luis
Author-email: asper@caspersci.uk.to
License: MPLv2.0
Description-Content-Type: UNKNOWN
Description: git-fame
        ========
        
        Pretty-print ``git`` repository collaborators sorted by contributions.
        
        |PyPI-Status| |PyPI-Versions|
        
        |Build-Status| |Coverage-Status| |Branch-Coverage-Status| |Codacy-Grade|
        
        |LICENCE| |Donate| |OpenHub-Status|
        
        .. code:: sh
        
            ~$ git fame
            Blame: 100%|███████████████████████████████████| 11/11 [00:00<00:00, 208.43it/s]
            Total commits: 302
            Total files: 37
            Total loc: 3134
            +----------------------+------+------+------+----------------+
            | Author               |  loc | coms | fils |  distribution  |
            +======================+======+======+======+================+
            | Casper da Costa-Luis | 3123 |  297 |   35 | 99.6/98.3/85.4 |
            | Not Committed Yet    |    7 |    4 |    2 |  0.2/ 1.3/ 4.9 |
            | Evïan Etàcidñys      |    4 |    1 |    1 |  0.1/ 0.3/ 2.4 |
            +----------------------+------+------+------+----------------+
        
        The ``distribution`` column is a percentage breakdown of the other columns
        (e.g. in the table above, Casper has written surviving code in
        ``35/37 = 85.4%`` of all files)
        
        ------------------------------------------
        
        .. contents:: Table of contents
           :backlinks: top
           :local:
        
        
        Installation
        ------------
        
        Latest PyPI stable release
        ~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        |PyPI-Status|
        
        .. code:: sh
        
            pip install git-fame
        
        Latest development release on github
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        |GitHub-Status|
        
        Pull and install in the current directory:
        
        .. code:: sh
        
            pip install -e git+https://github.com/casperdcl/git-fame.git@master#egg=git-fame
        
        Register alias with git
        ~~~~~~~~~~~~~~~~~~~~~~~
        
        This is probably not necessary on UNIX systems.
        
        .. code:: sh
        
            git config --global alias.fame "!python -m gitfame"
        
        Tab completion
        ~~~~~~~~~~~~~~
        
        Optionally, systems with ``bash-completion`` can install tab completion
        support. The
        `git-fame_completion.bash <https://raw.githubusercontent.com/casperdcl/git-fame/master/git-fame_completion.bash>`__
        file needs to be copied to an appropriate folder.
        
        On Ubuntu, the procedure would be:
        
        .. code:: sh
        
            $ # Ensure completion works for `git` itself
            $ sudo apt-get install bash-completion
        
            $ # Install `git fame` completions
            $ sudo cp git-fame_completion.bash /etc/bash_completion.d/
        
        followed by a terminal restart.
        
        
        Usage
        -----
        
        .. code:: sh
        
            git fame              # If alias registered with git (see above)
            git-fame              # Alternative execution as python console script
            python -m gitfame     # Alternative execution as python module
            git-fame -h           # Print help
        
        For example, to print statistics regarding all source files in a C++/CUDA
        repository (``*.c/h/t(pp), *.cu(h)``), carefully handling whitespace and line
        copies:
        
        .. code:: sh
        
            git fame --incl '\.[cht][puh]{0,2}$' -twMC
        
        It is also possible to run from within a python shell or script.
        
        .. code:: python
        
            >>> import gitfame
            >>> gitfame.main(['--sort=commits', '-wt', '/path/to/my/repo'])
        
        
        Documentation
        -------------
        
        .. code:: sh
        
            Usage:
              gitfame [--help | options] [<gitdir>]
        
            Arguments:
              <gitdir>       Git directory [default: ./].
        
            Options:
              -h, --help     Print this help and exit.
              -v, --version  Print module version and exit.
              --branch=<b>    Branch or tag [default: HEAD].
              --sort=<key>    [default: loc]|commits|files.
              --excl=<f>      Excluded files (default: None).
                              In no-regex mode, may be a comma-separated list.
                              Escape (\,) for a literal comma (may require \\, in shell).
              --incl=<f>      Included files [default: .*]. See `--excl` for format.
              -n, --no-regex  Assume <f> are comma-separated exact matches
                              rather than regular expressions [default: False].
                              NB: if regex is enabled `,` is equivalent to `|`.
              -s, --silent-progress    Suppress `tqdm` [default: False].
              -t, --bytype             Show stats per file extension [default: False].
              -w, --ignore-whitespace  Ignore whitespace when comparing the parent's
                                       version and the child's to find where the lines
                                       came from [default: False].
              -M              Detect intra-file line moves and copies [default: False].
              -C              Detect inter-file line moves and copies [default: False].
              --log=<lvl>     FATAL|CRITICAL|ERROR|WARN(ING)|[default: INFO]|DEBUG|NOTSET.
        
        
        Licence
        -------
        
        Open Source (OSI approved): |LICENCE|
        
        Copyright (c) 2016-8 Casper da Costa-Luis.
        
        This Source Code Form is subject to the terms of the
        Mozilla Public License, v. 2.0.
        If a copy of the MPL was not distributed with this file, You can obtain one
        at `https://mozilla.org/MPL/2.0/ <https://mozilla.org/MPL/2.0/>`__.
        
        
        Authors
        -------
        
        |OpenHub-Status|
        
        - Casper da Costa-Luis (`@casperdcl <https://github.com/casperdcl/>`__) |Donate|
        
        |git-fame-hits|
        
        .. |Build-Status| image:: https://travis-ci.org/casperdcl/git-fame.svg?branch=master
           :target: https://travis-ci.org/casperdcl/git-fame
        .. |Coverage-Status| image:: https://coveralls.io/repos/casperdcl/git-fame/badge.svg?branch=master
           :target: https://coveralls.io/github/casperdcl/git-fame
        .. |Branch-Coverage-Status| image:: https://codecov.io/gh/casperdcl/git-fame/branch/master/graph/badge.svg
           :target: https://codecov.io/gh/casperdcl/git-fame
        .. |GitHub-Status| image:: https://img.shields.io/github/tag/casperdcl/git-fame.svg?maxAge=2592000
           :target: https://github.com/casperdcl/git-fame/releases
        .. |PyPI-Status| image:: https://img.shields.io/pypi/v/git-fame.svg
           :target: https://pypi.python.org/pypi/git-fame
        .. |PyPI-Versions| image:: https://img.shields.io/pypi/pyversions/git-fame.svg
           :target: https://pypi.python.org/pypi/git-fame
        .. |git-fame-hits| image:: https://caspersci.uk.to/cgi-bin/hits.cgi?q=git-fame&a=hidden
        .. |OpenHub-Status| image:: https://www.openhub.net/p/git-fame/widgets/project_thin_badge?format=gif
           :target: https://www.openhub.net/p/git-fame?ref=Thin+badge
        .. |LICENCE| image:: https://img.shields.io/pypi/l/git-fame.svg
           :target: https://mozilla.org/MPL/2.0/
        .. |Codacy-Grade| image:: https://api.codacy.com/project/badge/Grade/bde789ee0e57491eb2bb8609bd4190c3
           :target: https://www.codacy.com/app/casper-dcl/git-fame
        .. |Donate| image:: https://img.shields.io/badge/gift-donate-dc10ff.svg
           :target: https://caspersci.uk.to/donate.html
        
Keywords: git blame stat stats statistics count author commit commits log shortlog ls-files
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Environment :: MacOS X
Classifier: Environment :: Other Environment
Classifier: Environment :: Win32 (MS Windows)
Classifier: Environment :: X11 Applications
Classifier: Framework :: IPython
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Other Audience
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: BSD
Classifier: Operating System :: POSIX :: BSD :: FreeBSD
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: POSIX :: SunOS/Solaris
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation
Classifier: Programming Language :: Python :: Implementation :: IronPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Desktop Environment
Classifier: Topic :: Education :: Computer Aided Instruction (CAI)
Classifier: Topic :: Education :: Testing
Classifier: Topic :: Office/Business
Classifier: Topic :: Other/Nonlisted Topic
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Pre-processors
Classifier: Topic :: Software Development :: User Interfaces
Classifier: Topic :: System :: Installation/Setup
Classifier: Topic :: System :: Logging
Classifier: Topic :: System :: Monitoring
Classifier: Topic :: System :: Shells
Classifier: Topic :: Terminals
Classifier: Topic :: Utilities
Provides: gitfame
