Skip to content
Python Central Hub

GitHub Profile Viewer

View on GitHub

Abstract

GitHub Profile Viewer is a Python project that fetches and displays GitHub user profiles using the GitHub API. It demonstrates API integration, data parsing, and GUI development. This project is ideal for learning about REST APIs, JSON handling, and interactive desktop apps.

Prerequisites

  • Python 3.6 or above
  • requests (pip install requestspip install requests)
  • tkinter (usually pre-installed)

Before you Start

Install Python and requests. Obtain a GitHub username for testing.

Getting Started

  1. Create a folder named github-profile-viewergithub-profile-viewer.
  2. Create a file named github_profile_viewer.pygithub_profile_viewer.py.
  3. Copy the code below into your file.
⚙️ GitHub Profile Viewer
GitHub Profile Viewer
"""
GitHub Profile Viewer
 
A Python application that fetches and displays GitHub user profile information using the GitHub API.
Features include:
- Fetching user details like name, bio, repositories, followers, etc.
- Displaying the information in a user-friendly format.
"""
 
import requests
from tkinter import Tk, Label, Entry, Button, Text, END, messagebox
 
 
class GitHubProfileViewer:
    def __init__(self, root):
        self.root = root
        self.root.title("GitHub Profile Viewer")
 
        Label(root, text="Enter GitHub Username:").grid(row=0, column=0, padx=10, pady=10)
        self.username_entry = Entry(root, width=30)
        self.username_entry.grid(row=0, column=1, padx=10, pady=10)
 
        Button(root, text="Fetch Profile", command=self.fetch_profile).grid(row=1, column=0, columnspan=2, pady=10)
 
        self.result_text = Text(root, width=50, height=20)
        self.result_text.grid(row=2, column=0, columnspan=2, padx=10, pady=10)
 
    def fetch_profile(self):
        """Fetch GitHub profile information for the entered username."""
        username = self.username_entry.get()
        if not username:
            messagebox.showerror("Error", "Please enter a GitHub username.")
            return
 
        url = f"https://api.github.com/users/{username}"
        response = requests.get(url)
 
        if response.status_code == 200:
            data = response.json()
            self.display_profile(data)
        else:
            messagebox.showerror("Error", f"Failed to fetch profile. Status code: {response.status_code}")
 
    def display_profile(self, data):
        """Display the fetched profile information in the text widget."""
        self.result_text.delete(1.0, END)
        self.result_text.insert(END, f"Name: {data.get('name', 'N/A')}\n")
        self.result_text.insert(END, f"Bio: {data.get('bio', 'N/A')}\n")
        self.result_text.insert(END, f"Public Repos: {data.get('public_repos', 'N/A')}\n")
        self.result_text.insert(END, f"Followers: {data.get('followers', 'N/A')}\n")
        self.result_text.insert(END, f"Following: {data.get('following', 'N/A')}\n")
        self.result_text.insert(END, f"Profile URL: {data.get('html_url', 'N/A')}\n")
 
 
def main():
    root = Tk()
    app = GitHubProfileViewer(root)
    root.mainloop()
 
 
if __name__ == "__main__":
    main()
GitHub Profile Viewer
"""
GitHub Profile Viewer
 
A Python application that fetches and displays GitHub user profile information using the GitHub API.
Features include:
- Fetching user details like name, bio, repositories, followers, etc.
- Displaying the information in a user-friendly format.
"""
 
import requests
from tkinter import Tk, Label, Entry, Button, Text, END, messagebox
 
 
class GitHubProfileViewer:
    def __init__(self, root):
        self.root = root
        self.root.title("GitHub Profile Viewer")
 
        Label(root, text="Enter GitHub Username:").grid(row=0, column=0, padx=10, pady=10)
        self.username_entry = Entry(root, width=30)
        self.username_entry.grid(row=0, column=1, padx=10, pady=10)
 
        Button(root, text="Fetch Profile", command=self.fetch_profile).grid(row=1, column=0, columnspan=2, pady=10)
 
        self.result_text = Text(root, width=50, height=20)
        self.result_text.grid(row=2, column=0, columnspan=2, padx=10, pady=10)
 
    def fetch_profile(self):
        """Fetch GitHub profile information for the entered username."""
        username = self.username_entry.get()
        if not username:
            messagebox.showerror("Error", "Please enter a GitHub username.")
            return
 
        url = f"https://api.github.com/users/{username}"
        response = requests.get(url)
 
        if response.status_code == 200:
            data = response.json()
            self.display_profile(data)
        else:
            messagebox.showerror("Error", f"Failed to fetch profile. Status code: {response.status_code}")
 
    def display_profile(self, data):
        """Display the fetched profile information in the text widget."""
        self.result_text.delete(1.0, END)
        self.result_text.insert(END, f"Name: {data.get('name', 'N/A')}\n")
        self.result_text.insert(END, f"Bio: {data.get('bio', 'N/A')}\n")
        self.result_text.insert(END, f"Public Repos: {data.get('public_repos', 'N/A')}\n")
        self.result_text.insert(END, f"Followers: {data.get('followers', 'N/A')}\n")
        self.result_text.insert(END, f"Following: {data.get('following', 'N/A')}\n")
        self.result_text.insert(END, f"Profile URL: {data.get('html_url', 'N/A')}\n")
 
 
def main():
    root = Tk()
    app = GitHubProfileViewer(root)
    root.mainloop()
 
 
if __name__ == "__main__":
    main()
  1. Run the script: python github_profile_viewer.pypython github_profile_viewer.py

Explanation

Code Breakdown

  1. Import required modules.
import requests
import tkinter as tk
import requests
import tkinter as tk
  1. Fetch GitHub profile data.
url = f'https://api.github.com/users/{username}'
response = requests.get(url)
data = response.json()
url = f'https://api.github.com/users/{username}'
response = requests.get(url)
data = response.json()
  1. Display profile in GUI.
root = tk.Tk()
root.title('GitHub Profile Viewer')
# ...setup widgets for profile display...
root.mainloop()
root = tk.Tk()
root.title('GitHub Profile Viewer')
# ...setup widgets for profile display...
root.mainloop()

Features

  • Fetches GitHub user profiles
  • Displays profile info in GUI
  • Easy to extend for more features

How It Works

  • User enters GitHub username
  • App fetches and displays profile info

GUI Components

  • Label: Shows profile info
  • Entry box: For username input
  • Button: Fetches profile

Use Cases

  • View GitHub profiles
  • Learn API integration
  • Build custom dashboards

Next Steps

You can enhance this project by:

  • Displaying repositories
  • Showing followers/following
  • Improving GUI design
  • Adding charts or graphs

Enhanced Version Ideas

def show_repositories():
    # Display user's repositories
    pass
 
def show_followers():
    # Display user's followers
    pass
def show_repositories():
    # Display user's repositories
    pass
 
def show_followers():
    # Display user's followers
    pass

Troubleshooting Tips

  • API errors: Check username and internet connection
  • GUI not showing: Ensure Tkinter is installed

Conclusion

This project teaches API usage, JSON parsing, and GUI basics. Extend it for more features and better user experience.

Was this page helpful?

Let us know how we did