5/25/2013

Travis CI oraz PyPI badges

Jeżeli korzystasz z Travis-CI do testowania swojego repozytorium na githubie oraz trzymasz paczkę na pypi, możesz w łatwy i prosty sposób dodać informacje na temat statusu do pliku README. Dzięki temu userzy będą widzieć czy wszystkie testy przeszły pomyślnie, jaka jest aktualna wersja paczki oraz jaka jest ilość ściągnięć. U mnie dla repo RandomWords wygląda to tak:

Travis-CI

W dokumentacji travis-ci znajdziesz informacje o tym co musisz umiejscowić w odpowiednim pliku.

PyPI

Osobiście korzystam z dwóch formatów. Markdown dla github oraz reStructuredText dla PyPI.

Markdown:
[![PyPi version](https://pypip.in/v/$REPO-NAME/badge.png)](https://crate.io/packages/$REPO-NAME/)
[![PyPi downloads](https://pypip.in/d/$REPO-NAME/badge.png)](https://crate.io/packages/$REPO-NAME/)
reStructuredText:
.. image:: https://pypip.in/v/$REPO-NAME/badge.png
    :target: https://crate.io/packages/$REPO-NAME/
    :alt: Latest PyPI version

.. image:: https://pypip.in/d/$REPO-NAME/badge.png
    :target: https://crate.io/packages/$REPO-NAME/
    :alt: Number of PyPI downloads
Przykład dla markdown znajdziesz tutaj, a dla reStructuredText tutaj. Zachęcam do używania.