core.py

from dataclasses import dataclass
from enum import Enum
from typing import List, Dict, Any

import pandas as pd
import requests


@dataclass
class RepositoryData:
    """
    Data class for storing repository information.

    Attributes:
        full_name (str): The name of the repository.
        star_count (int): The number of stars the repository has.
        fork_count (int): The number of forks the repository has.
    """
    full_name: str
    star_count: int
    fork_count: int

    @classmethod
    def from_json(cls, data: Dict[str, Any]) -> 'RepositoryData':
        full_name = data['full_name']
        star_count = data['stargazers_count']
        fork_count = data['forks_count']
        return cls(full_name=full_name, star_count=star_count, fork_count=fork_count)


class RepositoryType(Enum):
    """
    Enum for specifying types of repositories.

    Attributes:
        ALL: Represents all types of repositories.
        PUBLIC: Represents public repositories.
        PRIVATE: Represents private repositories.
        FORKS: Represents forked repositories.
        SOURCES: Represents source repositories.
        MEMBER: Represents member repositories.
    """

    ALL = "all"
    PUBLIC = "public"
    PRIVATE = "private"
    FORKS = "forks"
    SOURCES = "sources"
    MEMBER = "member"


def list_organization_repositories(
    github_token: str,
    organization_name: str,
    repository_type: RepositoryType = RepositoryType.ALL,
    page: int = 1
) -> List:
    """
    Lists the repositories of a specified GitHub organization based on the repository
    type and page number.

    Args:
        github_token (str): The GitHub personal access token for authentication.
        organization_name (str): The name of the GitHub organization whose repositories
            are to be listed.
        repository_type (RepositoryType): The type of repositories to list. Defaults to
            RepositoryType.ALL.
        page (int): The page number of the results to fetch. Defaults to 1.

    Returns:
        List: A list containing details of the organization's repositories.
    """

    headers = {
        "Accept": "application/vnd.github+json",
        "Authorization": f"Bearer {github_token}",
        "X-GitHub-Api-Version": "2022-11-28"
    }

    params = {
        "type": repository_type.value,
        "page": page
    }

    url = f"https://api.github.com/orgs/{organization_name}/repos"

    response = requests.get(url, headers=headers, params=params)
    return response.json()


def to_dataframe(repositories: List[RepositoryData]) -> pd.DataFrame:
    """
    Convert a list of RepositoryData objects into a pandas DataFrame.

    Args:
        repositories (List[RepositoryData]): A list of RepositoryData objects.

    Returns:
        pd.DataFrame: A DataFrame where each row represents a repository, with columns
            for the repository's name and star count.
    """
    data = [
        {'full_name': repository.full_name, 'star_count': repository.star_count}
        for repository
        in repositories
    ]
    return pd.DataFrame(data)