Skip to content

nschloe/gitfaces

Repository files navigation

gitfaces

PyPi Version PyPI pyversions GitHub stars PyPi downloads

gh-actions codecov Code style: black

gitfaces collects avatars for all contributors of a given Git repository. (This can be used for Gource's --user-image-dir, for example.)

Simply type

gitfaces /path/to/git/repo out/

and gitfaces will start fetching from Gravatar and GitHub. Once done, the out/ directory will contain all the avatars.

Installation

gitfaces is available from the Python Package Index, so simply type

pip install -U gitfaces

to install or upgrade.

Testing

To run the gitfaces unit tests, check out this repository, set the environment variable GITFACES_TEST to the local path of a Git repository on which you would like the tests to be performed, and type

pytest

License

This software is published under the GPLv3 license.