github-stats

GitHub Stats is a simple, free, and open-source GitHub profile statistics generator. This project was built using Python programming language with web framework Flask in accordance with GitHub API documentation. This project was inspired by github-readme-stats.

Features 💡

Using Github Stats, you can:

• Create and customize badge for your GitHub profile.
• Use GitHub REST API to get the data.
• Use GitHub GraphQL API to get the data.

Usage 👨‍💻

Create your own badge by change the USERNAME and THEME in the URL below. Curently there are 2 themes available: dark and light.

https://github-stats-putuwaw.vercel.app/api?username=USERNAME&theme=THEME

Note

You can also use the GraphQL API by using /api/graphql endpoint instead of REST API on /api endpoint.

Examples:

Dark theme:

Light theme:

Prerequisites 📋

• Python 3.10 or higher

Installation 🛠

• Clone the repository:

git clone https://github.com/putuwaw/github-stats.git

• Create a virtual environment and activate it:

python -m venv venv
source venv/bin/activate

• Install the dependencies:

make py-install

• Create .env file and set the environment variables for GitHub API:

make env

• Run the application:

make run

Contributing 🤝

Contributions are welcome! Please read the contributing guidelines first.

License 📝

This project is licensed under the MIT License. See the LICENSE file for details.