# showExposedGitHubEmails
Is a crawler which lists all email addresses used in commits of a specific GitHub user using the GitHub API.
It iterates through all public respositories owned by the user and all commits in each of these repositories.
## Installation
Install the package with pip
pip install exposed-github-user-emails-scanner
## Usage
Type ```showExposedGitHubEmails --help``` to view the help.
```
usage: showExposedGitHubEmails [OPTION]... -u USERNAME
A crawler which lists all email addresses used in commits of a specific GitHub user using the GitHub API.
optional arguments:
-h, --help show this help message and exit
-u USER, --user USER username of the user whose public repositories should be scanned
-r REPOSITORY, --repository REPOSITORY
name of specific repository which should be scanned (default is all repositories)
-t TOKEN, --token TOKEN
provide a GitHub token to increase the API quota which can be used by this script
-v, --verbose verbose mode
-d DELAY, --delay DELAY
the delay between to requests in seconds (default is 1 second)
--api-url API_URL specify the URL to the GitHub Api (default is "https://api.github.com")
--no-forks ignore forked repositories
```
## Example
```
$ showExposedGitHubEmails -u AFictionalUsername
[+] Scan for public repositories of user AFictionalUsername
[+] Found 4 public repositories
[+] Scan repository my_first_project
[+] Scan repository project_2
[+] Exposed emails and names:
41277220+aficionalusername@users.noreply.github.com - John Doe
john.doe@hotmail.com - JD; John Doe
john.doe@company.com - John Doe (Software Eng.)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/wahlflo/showExposedGitHubEmails",
"name": "exposed-github-user-emails-scanner",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Florian Wahl",
"author_email": "florian.wahl.developer@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b5/7a/0c3c1ae8a27bea1af72553f91c35b97ddbafef120bd25eb90b4eb5d53f0e/exposed_github_user_emails_scanner-1.0.7.tar.gz",
"platform": null,
"description": "# showExposedGitHubEmails\r\nIs a crawler which lists all email addresses used in commits of a specific GitHub user using the GitHub API.\r\n\r\nIt iterates through all public respositories owned by the user and all commits in each of these repositories. \r\n\r\n\r\n## Installation\r\n\r\nInstall the package with pip\r\n\r\n pip install exposed-github-user-emails-scanner\r\n\r\n## Usage\r\nType ```showExposedGitHubEmails --help``` to view the help.\r\n\r\n```\r\nusage: showExposedGitHubEmails [OPTION]... -u USERNAME\r\n\r\nA crawler which lists all email addresses used in commits of a specific GitHub user using the GitHub API.\r\n\r\noptional arguments:\r\n -h, --help show this help message and exit\r\n -u USER, --user USER username of the user whose public repositories should be scanned\r\n -r REPOSITORY, --repository REPOSITORY\r\n name of specific repository which should be scanned (default is all repositories)\r\n -t TOKEN, --token TOKEN\r\n provide a GitHub token to increase the API quota which can be used by this script\r\n -v, --verbose verbose mode\r\n -d DELAY, --delay DELAY\r\n the delay between to requests in seconds (default is 1 second)\r\n --api-url API_URL specify the URL to the GitHub Api (default is \"https://api.github.com\")\r\n --no-forks ignore forked repositories\r\n\r\n```\r\n\r\n## Example\r\n```\r\n$ showExposedGitHubEmails -u AFictionalUsername\r\n[+] Scan for public repositories of user AFictionalUsername\r\n[+] Found 4 public repositories\r\n[+] Scan repository my_first_project\r\n[+] Scan repository project_2\r\n[+] Exposed emails and names:\r\n 41277220+aficionalusername@users.noreply.github.com - John Doe\r\n john.doe@hotmail.com - JD; John Doe\r\n john.doe@company.com - John Doe (Software Eng.)\r\n```\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A cli script to find exposed email addresses of one GitHub user in his or her public repositories.",
"version": "1.0.7",
"project_urls": {
"Homepage": "https://github.com/wahlflo/showExposedGitHubEmails"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "644c84ac0b7d7951a154f06c6dfc9b3118599ab35b31337cbd318871af324c91",
"md5": "03e280aec7313f724d6fe52b882f6c8e",
"sha256": "877d27f8eb6e15826fda2ba19d54487206ebca6b2f9a0360330b7d9c3b4001a8"
},
"downloads": -1,
"filename": "exposed_github_user_emails_scanner-1.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "03e280aec7313f724d6fe52b882f6c8e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6207,
"upload_time": "2024-04-04T14:29:46",
"upload_time_iso_8601": "2024-04-04T14:29:46.542628Z",
"url": "https://files.pythonhosted.org/packages/64/4c/84ac0b7d7951a154f06c6dfc9b3118599ab35b31337cbd318871af324c91/exposed_github_user_emails_scanner-1.0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b57a0c3c1ae8a27bea1af72553f91c35b97ddbafef120bd25eb90b4eb5d53f0e",
"md5": "a24bf708ebf68184e0dd9a0e909a7087",
"sha256": "da66aebf27b303a2ead9ca6054470f591943a329179d26f1c56745204d7b33a8"
},
"downloads": -1,
"filename": "exposed_github_user_emails_scanner-1.0.7.tar.gz",
"has_sig": false,
"md5_digest": "a24bf708ebf68184e0dd9a0e909a7087",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5128,
"upload_time": "2024-04-04T14:29:50",
"upload_time_iso_8601": "2024-04-04T14:29:50.171689Z",
"url": "https://files.pythonhosted.org/packages/b5/7a/0c3c1ae8a27bea1af72553f91c35b97ddbafef120bd25eb90b4eb5d53f0e/exposed_github_user_emails_scanner-1.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-04 14:29:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "wahlflo",
"github_project": "showExposedGitHubEmails",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "exposed-github-user-emails-scanner"
}
JSON
