Badge request: Patreon
- Dominant language
- JavaScript
- Stars
- 27.2k
- Forks
- 5.6k
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 46
Description
:clipboard: **Description**
I'd like Patreon badges that can display the number of patrons a creator has or the amount of money pledged to the creator per month. For example:
`monthly patrons | 3`
`receiving | $5/mo`
(I based these examples loosely on the existing funding badges, but the specific format isn't solid.)
:link: **Data**
Patreon has a [REST API](https://docs.patreon.com/#introduction). At the moment, it appears it requires OAuth to access. There is [a post on the Patreon Developers forum](https://www.patreondevelopers.com/t/acces-readonly-data-without-oauth/1803) about the possibility of including a way to access read-only data about a creator (including patron count and monthly earnings) without authentication. I assume that this issue would be blocked on such an unauthenticated API being created.
:microphone: **Motivation**
I'd like to promote my Patreon creator page on my repositories as a way of obtaining funding.
Contributor guide
Research direction
Start by reviewing the linked Patreon REST API documentation and the issue's note about OAuth requirements. The work is only ready to define once Patreon provides unauthenticated creator data; completion would require agreed badge formats for patron count or monthly pledges and an accessible data source.
Written by the indexing model from the issue text.
Assessment
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100