Here’s a suggested description for your GitHub repository and a README outline to help you explain the tool’s purpose, features, and usage.
GitHub Repository Description:
Automated Web Search Tool for Finding Profiles
This Python script automates the process of searching for individuals based on their names and an associated organization/community name. With just a list of names and a follow-up string, the tool will search for their profiles on Google, making it easier to connect with people and discover information about them online.
README:
SearchMate - Automated Web Search Tool
SearchMate is a Python-based tool that automates the process of searching for people online by taking a list of names and appending an organization or community name to each search query. This allows you to quickly find profiles of individuals associated with a specific community or organization, saving time and increasing productivity.
Features:
- Automates Google search queries by combining names with a follow-up string (e.g., an organization or community name).
- Opens a new browser tab for each search result.
- Saves time by eliminating the need for manual searches across multiple people.
- Simple and efficient, requiring minimal setup.
Use Case Example: Suppose you have a list of names like:
- Ansh Jaiswal, John Doe, Jane Smith
And you want to search for their profiles related to:
- GSOC CERN
By entering "GSOC CERN" as the follow-up string, the script will automatically open browser tabs to search for each person with the string "GSOC CERN", enabling you to find their profiles quickly.
How It Works:
- Input a list of names separated by commas (e.g., "Ansh Jaiswal, John Doe").
- Input a follow-up string that describes the organization or community you're interested in (e.g., "GSOC CERN").
- The script will open Google search results for each name + follow-up string combination, making it easy to find profiles and connect with people.
Installation:
- Clone the repository:
git clone https://github.com/anshjaiswal12/SearchMate.git
- Navigate to the directory:
cd SearchMate - Ensure you have Python installed. This script requires Python 3.x.
Usage:
- Open a terminal and run the script:
python SearchMate.py
- You’ll be prompted to input the follow-up string and the list of names.
- The script will automatically search for the profiles using Google and open the results in a browser.
Contributing: Feel free to fork the repository, submit issues, and suggest improvements. Contributions are welcome!
- Enhancements: You can suggest or add new features like searching on different platforms (LinkedIn, Twitter, etc.) or exporting results to a CSV file.
- Bug Reports: If you find any bugs or issues with the script, feel free to create a GitHub issue.
License: This project is open-source and available under the MIT License. See the LICENSE file for more information.
With this structure, your README will provide a clear understanding of the tool's purpose, how to set it up, and how others can contribute or use it. Let me know if you'd like to modify or expand any part!