daniijal / github-user-contributions

Gets GitHub total contributions of a user profile without using github api

GitHub User Contributions 👨🏻‍💻

• Simple api to get GitHub user contributions ( No GitHub api key is needed ).
• Simply use the raw Json once your username is updated. ( Typically, within a minute or so )
• Any help/suggestions are welcome ⚡ 👍🏻

Usage

• Comment your username in the discussion thread
  • Format: @username
  • This is one time process only
• Wait for the python_build workflow to complete
  • Workflow will take about 1 minute to complete
  • Your contributions will be updated once workflow completes
• Check the end-points with your username mentioned below
• Since the response is in json, you can use it how-ever you like it!
• Also, your contributions will be updated every day at 00:00 UTC 😀

Endpoints

• These are the endpoints that you can use with your username:
• Right now response has
  • username: str
  • fullname: str
  • contributions: int

No.	Endpoint	Parameters	Description	Example
1	https://raw.githubusercontent.com/ankitsumitg/github-user-contributions/main/api/v1/username/YYYY/MM/DD.json	username YYYY MM DD	Contribution for a particular Day	https://raw.githubusercontent.com/ankitsumitg/github-user-contributions/main/api/v1/ankitsumitg/2022/07/17.json
2	https://raw.githubusercontent.com/ankitsumitg/github-user-contributions/main/api/v1/username/YYYY/MM.json	username YYYY MM	Contribution for a particular Month	https://raw.githubusercontent.com/ankitsumitg/github-user-contributions/main/api/v1/ankitsumitg/2022/07.json
3	https://raw.githubusercontent.com/ankitsumitg/github-user-contributions/main/api/v1/username/YYYY.json	username YYYY	Contribution for a particular Year	https://raw.githubusercontent.com/ankitsumitg/github-user-contributions/main/api/v1/ankitsumitg/2022.json
4	https://raw.githubusercontent.com/ankitsumitg/github-user-contributions/main/api/v1/username/LASTYEAR.json	username	Contribution since Last Year	https://raw.githubusercontent.com/ankitsumitg/github-user-contributions/main/api/v1/ankitsumitg/LASTYEAR.json
5	https://raw.githubusercontent.com/ankitsumitg/github-user-contributions/main/api/v1/username/LIFETIME.json	username	Contribution all Lifetime 😎	https://raw.githubusercontent.com/ankitsumitg/github-user-contributions/main/api/v1/ankitsumitg/LIFETIME.json

Sample response for 1st example endpoint

  {
    "username": "ankitsumitg", 
    "fullname": "Ankit Gupta", 
    "contribution": 9
  }

Internal Working

• Internally, the github-user-contributions runs a python script that crawls and scrapes the skyline-contributions from GitHub users page
• Everything happens asynchronously
• python_build workflow runs the script and updates the user contributions

Notes

• If a user had not made private contributions visible on GitHub profile, then only the public contributions will be counted

License

Contributors