LoL Stat Badges

About The Project:

Have you ever wished you could display your accomplishments in League of Legends in the same way that you display your GitHub tech stack? No? Well too bad! Introducing LoL Stat Badges! Display your League of Legends rank on your GitHub README files or anywhere else that supports SVG embeds!

     

Tech Stack:

       

Tests:

API Usage:

To display your degeneracy, follow the steps below:

• Embed the base URL - https://api.ryanpolasky.com/lol/badge
• Add your region (options listed here) to the path - https://api.ryanpolasky.com/lol/badge/NA1
• Add your Riot ID name to the path - https://api.ryanpolasky.com/lol/badge/NA1/Eggy
  • If your Riot ID name has spaces, replace them with %20 in the URL
  • Note: This API currently does not work with
• Add your Riot ID tag to the path - https://api.ryanpolasky.com/lol/badge/NA1/Eggy/NEW
• Embed your shame into your GitHub README - ![LoL Stat Badge](https://api.ryanpolasky.com/lol/badge/NA1/Eggy/NEW) 
  • The   tag is simply for formatting, so feel free to omit it if desired :)

If you want the badge to show the name of the rank instead of your Riot ID, include ?rank_name=true at end of your embed URL.

Next Steps:

• Figure out a way to measure the length of a username for dynamic badge sizing
  • Current method is decent, but certain names can lead to shorter/longer than necessary badges
• Add additional styles to match the Shields.io styles listed here
• Add caching
  • Might not be necessary as the main use case is GitHub, which already caches for at least a day
• Finalize Python tests
• Add support for specifying which ranked queue to use
  • Currently only functions with Solo/Duo queue
• Check if Teamfight Tactics (TFT) support can be added & implement it if it can be
  • Looks like TFT can be added!
• Add champion mastery as a style option
• Add support for non-Latin/CJK characters
• Maybe create standardized Riot API Python wrapper package if one doesn't already exist

Issues/Contact:

If a red badge renders with "ERROR" written on it, double-check your arguments, as one or more argument is invalid. If there are any issues with the API, or if you need to contact me for any other reason, please use my Email or LinkedIn below!