Styles as supported by GITLAB and Shields.io

[krishvk]

Is it possible to use/support styles like other alternatives (GItlab and Shields.io)

[psincraian]

Hi,

Thanks for the suggestion!

It's possible but it will require some work, I will try to prioritize it based on the demand for it 😊

[hugovk]

Would it be possible for shields.io to provide the badges? They have many different options.

[ffe4]

@hugovk there is a guide on the shields GitHub repo on how to add a badge for a service

[finnmglas]

I suppose that it would be useful to at least implement the common GET arguments that https://shields.io implements:

label=<LABEL>&message=<MESSAGE>&color=<COLOR> plus the style argument

[finnmglas]

@krishvk Here is a inofficial implementation based on a comment by @psincraian :

plastic:

flat:

flat-square:

social:

generally something like this (don't forget to adjust the parameters, style etc):

![](https://img.shields.io/badge/dynamic/json?style=<STYLE>&label=downloads&query=%24.total_downloads&url=https%3A%2F%2Fapi.pepy.tech%2Fapi%2Fprojects%2Frequests)

---

I am not sure if this helps you, but it helped me ^^

[WenjieDu]

@krishvk Here is a inofficial implementation based on a comment by @psincraian :

plastic:

flat:

flat-square:

social:

generally something like this (don't forget to adjust the parameters, style etc):

![](https://img.shields.io/badge/dynamic/json?style=<STYLE>&label=downloads&query=%24.total_downloads&url=https%3A%2F%2Fapi.pepy.tech%2Fapi%2Fprojects%2Frequests)

I am not sure if this helps you, but it helped me ^^

It seems that the examples provided by @finnmglas are down, showing "resource not found".

[aMahanna]

It seems that the examples provided by @finnmglas are down, showing "resource not found".

@WenjieDu

Looks like the route changed - adding v2/ to the path seems to fix it:

Set the url query parameter of the img.shields.io API to https://api.pepy.tech/api/v2/projects/requests (instead of https://api.pepy.tech/api/projects/requests

https://img.shields.io/badge/dynamic/json?style=for-the-badge&label=downloads&query=%24.total_downloads&url=https%3A%2F%2Fapi.pepy.tech%2Fapi%2Fv2%2Fprojects%2Frequests

[WenjieDu]

Awesome! Thank you for your information @aMahanna 😊

[WenjieDu]

@aMahanna BTW, do you know how to make the displayed number of downloads be an abbreviation (e.g. 17K), rather than an exact number (e.g. 17342)? I tried to look for PePy documentation but failed. 🥲

[aMahanna]

@WenjieDu So the static.pepy.tech API allows you to abbreviate the number with the units=abbreviation query parameter

[![Downloads](https://static.pepy.tech/personalized-badge/requests?period=week&units=abbreviation&left_color=black&right_color=blue&left_text=Downloads)](https://pepy.tech/project/requests)

But unfortunately I am not sure how this query parameter would work if we are relying on the img.shields.io API to add a custom style

[WenjieDu]

@WenjieDu So the static.pepy.tech API allows you to abbreviate the number with the units=abbreviation query parameter

[![Downloads](https://static.pepy.tech/personalized-badge/requests?period=week&units=abbreviation&left_color=black&right_color=blue&left_text=Downloads)](https://pepy.tech/project/requests)

But unfortunately I am not sure how this query parameter would work if we are relying on the img.shields.io API to add a custom style

Right, that's true. api.pepy.tech only provides the exact number. It seems that shields.io doesn't offer such a function for abbreviation. Thank you anyway!