Skip to content

aixandrolab/githubinformer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitHub Informer v0.1.1


GitHub top language GitHub license GitHub release GitHub stars GitHub forks


Description

GitHub Informer is a simple yet effective tool that retrieves public repository information for any GitHub user. It provides an easy-to-use interface to access repository data including metadata, statistics, and other relevant information from GitHub's REST API.


⚠️ Disclaimer

By using this software, you agree to the full disclaimer terms.

Summary: Software provided "AS IS" without warranty. You assume all risks.

Full legal disclaimer: See DISCLAIMER.md


Features

  • Fetch all public repositories for a specified GitHub user
  • Access individual repository data by name
  • Get total repository count for a user
  • Retrieve complete repository dataset as a dictionary
  • Handles API errors gracefully
  • Supports up to 100 repositories per request

Installation

Prerequisites

  • Python 3.x
  • Internet connection for GitHub API access

Setup

  1. Clone the repository or download the source code:
git clone https://github.com/yourusername/github-informer.git
cd github-informer
  1. Ensure the package structure is correct:
github-informer/
├── githubinformer/
│   ├── __init__.py
│   └── github_informer.py
└── app.py

Usage

Basic Usage

from githubinformer.github_informer import GitHubInformer

# Create an informer instance for a GitHub user
informer = GitHubInformer("aixandrolab")

# Get all repositories data
repos_data = informer.get_github_repos_data()

# Get repository count
count = informer.get_repositories_count()
print(f"Total repositories: {count}")

# Get specific repository data
repo = informer.get_repo_data("Hello-World")
print(repo)

Command Line Interface

Run the main script:

python app.py

You'll be prompted to enter a GitHub username:

GitHub Name: aixandrolab

The script will then display the repository data for the specified user.


API Reference

Class: GitHubInformer

Constructor

  • __init__(user): Creates a new informer instance for the specified GitHub username

Methods

  • get_github_data(url): Class method that fetches and parses JSON data from a given URL
  • get_repo_data(name): Returns data for a specific repository by name
  • get_github_repos_data(): Returns all repositories data as a dictionary
  • get_repositories_count(): Returns the total number of repositories

Properties

  • github_repos_api_url: Returns the GitHub API URL used for fetching repository data

Data Structure

The method get_repo_data(name) returns a dictionary containing all repository information from GitHub's API, including:

  • Repository name and description
  • Creation and update dates
  • Star count, fork count, watchers
  • Language information
  • URL links (clone, HTML, API)
  • And other metadata provided by GitHub

Error Handling

The get_github_data method includes exception handling that will:

  • Print any errors that occur during API requests
  • Return an empty list if the request fails

Limitations

  • Fetches maximum of 100 repositories per user (GitHub API pagination not implemented)
  • Requires internet connection
  • No authentication support (public data only)
  • Rate limited by GitHub API (60 unauthenticated requests per hour)

Copyright (©) 2026, Alexander Suvorov. All right reserved.


Author

Alexander Suvorov - GitHub

About

GitHub Informer is a simple yet effective tool that retrieves public repository information for any GitHub user. It provides an easy-to-use interface to access repository data including metadata, statistics, and other relevant information from GitHub's REST API.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages