bpmcdevitt/github_searcher
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
A program that can be used to search through github using its REST API with PyGithub python library
10 commits 1 branch 0 tags 52 KiB
Python 98.6%
Dockerfile 1.4%
Find a file
kenna-bmcdevitt fc664d5ad3 made get repo contents method work recursively
2024-08-26 16:45:17 -05:00
.env.sample beginnings of a github searcher program 2024-08-26 11:16:40 -05:00
docker-compose.yml beginnings of a github searcher program 2024-08-26 11:16:40 -05:00
Dockerfile beginnings of a github searcher program 2024-08-26 11:16:40 -05:00
github_searcher.py made get repo contents method work recursively 2024-08-26 16:45:17 -05:00
README.md updated README 2024-08-26 16:09:39 -05:00

README.md

GitHub Searcher

GitHub Searcher is a command-line tool to search for PoC exploits for CVEs and security vulnerabilities in open-source software on GitHub. It allows you to search repositories, users, and repository names, and optionally fetch open issues and repository contents.

Features

  • Search GitHub repositories, users, and repository names.
  • Fetch open issues of a repository.
  • Fetch contents of a repository.

Requirements

  • Python 3.x
  • PyGithub library

Installation

  1. Clone the repository:

    git clone https://git.mcdevitt.tech/bpmcdevitt/github_searcher.git
cd github_searcher

  2. Install the required dependencies:

    pip install PyGithub

  3. Set your GitHub access token as an environment variable:

    export GITHUB_ACCESS_TOKEN=your_access_token

Usage

Run the script with the required arguments:

python3 github_searcher.py --query=<query> --search_type=<search_type> [--get_open_issues] [--get_file_contents]