Metadata-Version: 2.0
Name: gitfaces
Version: 0.1.6
Summary: fetch contributor avatars for a GitHub repository
Home-page: https://github.com/nschloe/gitfaces
Author: Nico Schlömer
Author-email: nico.schloemer@gmail.com
License: License :: OSI Approved :: MIT License
Download-URL: https://pypi.python.org/pypi/gitfaces
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Multimedia :: Graphics
Classifier: Topic :: Software Development :: Version Control
Requires-Dist: GitPython
Requires-Dist: Pillow
Requires-Dist: pipdated
Requires-Dist: requests

gitfaces
========

|Build Status| |PyPi Version| |GitHub stars|

gitfaces collects avatars for all contributors of a given Git
repository. (This can be used for
`Gource's <https://github.com/acaudwell/Gource>`__ ``--user-image-dir``,
for example.)

Simply type

::

    gitfaces /path/to/git/repo out/

and gitfaces will start fetching from
`Gravatar <https://en.gravatar.com/>`__ and
`GitHub <https://github.com/>`__. Once done, the ``out/`` directory will
contain all the avatars.

Installation
~~~~~~~~~~~~

gitfaces is `available from the Python Package
Index <https://pypi.python.org/pypi/gitfaces/>`__, 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

Distribution
~~~~~~~~~~~~

To create a new release

1. bump the ``__version__`` number,

2. publish to PyPi and GitHub:

   ::

       $ make publish

License
~~~~~~~

gitfaces is published under the `MIT
license <https://en.wikipedia.org/wiki/MIT_License>`__.

.. |Build Status| image:: https://travis-ci.org/nschloe/gitfaces.svg?branch=master
   :target: https://travis-ci.org/nschloe/gitfaces
.. |PyPi Version| image:: https://img.shields.io/pypi/v/gitfaces.svg
   :target: https://pypi.python.org/pypi/gitfaces
.. |GitHub stars| image:: https://img.shields.io/github/stars/nschloe/gitfaces.svg?style=social&label=Stars&maxAge=2592000
   :target: https://github.com/nschloe/gitfaces


