https://github.com/tethik/badger

Commandline Interface to create badges
https://github.com/tethik/badger

Last synced: 10 days ago
JSON representation

Commandline Interface to create badges

• Host: GitHub
• URL: https://github.com/tethik/badger
• Owner: Tethik
• License: mit
• Created: 2017-08-24T13:21:34.000Z (about 7 years ago)
• Default Branch: develop
• Last Pushed: 2021-04-27T13:06:16.000Z (over 3 years ago)
• Last Synced: 2024-10-11T08:26:48.498Z (27 days ago)
• Language: Python
• Homepage:
• Size: 438 KB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
badger

======

|version| |coverage|

Commandline Interface to create svg badges.

Install

-------

.. code:: bash

    pip install badger

Usage (Commandline)

-------------------

Simplest use case of static label and value:

.. code:: bash      

    badger version v0.1.2

Percentage mode, with color picked relative to where in the 0-100 range

the value is.

.. code:: bash

    badger -p coverage 71.29%

Usage (Package)

---------------

.. code:: python

    from badger import Badge, PercentageBadge

    badge = Badge("version", "v0.1.2")

    badge.save("examples/version.svg")

    percentage_badge = PercentageBadge("coverage", 71.29)

    badge.save("examples/coverage.svg")

Disclaimer

==========

Code originally heavily copied from https://github.com/dbrgn/coverage-badge 

Badge design originally from https://github.com/badges/shields

.. |version| image:: examples/version.svg

.. |coverage| image:: examples/coverage.svg