Skip to content

Latest commit

 

History

History
74 lines (47 loc) · 2.41 KB

README.md

File metadata and controls

74 lines (47 loc) · 2.41 KB
Raw

GitHub Repository Analyzer

Overview

The GitHub Repository Analyzer is a command-line tool that retrieves information about repositories created by a user in a specific year. It takes two parameters, the GitHub username and the year, and provides a list of repositories along with their creation date, link, repository name, and the primary programming language used.

Usage

Cloning the Repository

You can clone the repository to your local machine by running the following command:

git clone https://github.com/Saru2003/gh-repo.git

Alternatively, you can download the ZIP file and extract it.

Installing Dependencies

Before running the tool, ensure that you have the necessary Python modules installed. You can install them by running the following command:

pip install -r requirements.txt

After installing the requirements, Linux users need to follow these additional steps:

  • Navigate to the directory where the gh-repo repository is located. You can use the cd command to change the directory. For example:

    cd path/to/gh-repo

  • Make the gh-repo.py file executable by running the following command with root privileges:

    sudo chmod +x gh-repo.py

    This command grants executable access to the file.

Now you are ready to run the gh-repo.py script.

Running the Tool

To use the GitHub Repository Analyzer, execute the following command:

./gh-repo.py -u <USERNAME> -y <YEAR>

Replace with the desired GitHub username and with the year for which you want to retrieve repository information.

Docker Image

Alternatively, you can use the provided Docker image to run the tool. Make sure you have Docker installed on your machine. You can either pull the image or run it directly:

Pull the Docker image:

docker pull sarvesh20123/gh-repo

Run the Docker container:

docker run sarvesh20123/gh-repo -u <USERNAME> -y <YEAR>

Please note that the GitHub Repository Analyzer is cross-platform compatible and can be run on Linux, macOS, and Windows systems.

You can find the official Docker image for the GitHub Repository Analyzer on Docker Hub.

License

This project is licensed under the GNU General Public License. See the LICENSE file for details.