Skip to content

This tool is designed to search from a csv list of GitHub people. It accepts input as a search term, then searches the profile of each entry for the keyword(s) provided.

License

Notifications You must be signed in to change notification settings

gray-area/usersearch

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

3 Commits
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ” GitHub User Keyword Scanner

Search GitHub users for keywords in their repositories or code using a CSV list of profiles.

This tool reads a .csv file with GitHub user info, prompts you for keywords, and outputs a CSV of matching users along with the link to where the keyword was found.


πŸ“¦ Features

  • βœ… Accepts a CSV file with Query, Full Name, Username, Profile URL
  • πŸ” Searches:
    • Repository name + description
    • Code files using GitHub's code search
  • 🧠 Prompts you interactively for keywords
  • 🧾 Outputs matches to user_matches.csv including:
    • Full name
    • GitHub username
    • Profile URL
    • πŸ“Ž Link to the matched repository or file

βš™οΈ Requirements

  • Python 3
  • pandas and requests libraries

Install dependencies:

pip install pandas requests

πŸš€ Usage

python usersearch.py users.csv

You’ll be prompted like:

Enter keywords to search (comma-separated): machine learning, flask, etl

πŸ“„ Input CSV Format

Your CSV should include at least the following columns:

Query,Full Name,Username,Profile URL
data science,Alice Johnson,alicejohnson,https://github.com/alicejohnson
etl,Bob Smith,bsmith,https://github.com/bsmith

Column headers are case-insensitive and can contain spaces.


πŸ“€ Output Example (user_matches.csv)

fullname,username,profile_url,matched_url
Alice Johnson,alicejohnson,https://github.com/alicejohnson,https://github.com/alicejohnson/data-pipeline

πŸ” GitHub API Token (Optional but Recommended)

To avoid hitting GitHub’s anonymous rate limits, add your personal access token inside the script:

GITHUB_TOKEN = 'your_token_here'

Or load it from an environment variable:

import os
GITHUB_TOKEN = os.getenv("GITHUB_TOKEN")

πŸ› οΈ Customization Ideas

  • Save matched_keyword as well
  • Export to JSON instead of CSV
  • Add CLI flags for keyword input or output name

🧠 Author & License

Built with πŸ’» by [gray-area]. MIT Licensed.

About

This tool is designed to search from a csv list of GitHub people. It accepts input as a search term, then searches the profile of each entry for the keyword(s) provided.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages