https://github.com/rahulraikwar00/esfc

A simple python script to crawl all email address, name and username from a specific repository on GitHub.
https://github.com/rahulraikwar00/esfc

automation cli hacktoberfest2021 python

Last synced: 26 days ago
JSON representation

A simple python script to crawl all email address, name and username from a specific repository on GitHub.

• Host: GitHub
• URL: https://github.com/rahulraikwar00/esfc
• Owner: rahulraikwar00
• Created: 2021-06-22T09:32:21.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-12-13T22:38:57.000Z (11 months ago)
• Last Synced: 2023-12-13T23:35:44.223Z (11 months ago)
• Topics: automation, cli, hacktoberfest2021, python
• Language: Python
• Homepage:
• Size: 1000 Bytes
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Email Scraper for Commit History

This Python script is designed to extract email addresses, names, and usernames from the commit history of a specified GitHub repository.

## Setup Instructions

### Prerequisites

- Make sure you have Python 3 installed. You can check your Python version with `python --version`.

- Obtain a GitHub Personal Access Token (PAT) [here](https://github.com/settings/tokens) with the necessary scopes (e.g., `repo`).

### Installation

1. Clone this repository: `git clone https://github.com/rahulraikwar00/email-scraper.git`

2. Navigate to the project directory: `cd email-scraper`

3. Install dependencies: `pip install -r requirements.txt`

## Run Instructions

### Command-Line Options

- To view available command-line options: `python email_scrape.py --help`

### Example Usage

- Run the script with your GitHub token and the target repository: `python email_scrape.py  `

## Author

**[Rahul Raikwar](https://github.com/rahulraikwar00)**

- For inquiries or support, contact: [[email protected]]

## Disclaimers

- This script requires a GitHub Personal Access Token (PAT) to authenticate with the GitHub API.

- It does not store your GitHub Personal Access Token (PAT) or any extracted data.

## Contributing

Feel free to contribute to this project by submitting issues or pull requests [here](https://github.com/rahulraikwar00/email-scraper/issues).