https://github.com/prabhakar267/github_email
:mag_right: Python package to get email ID of any GitHub user even if they are not public
https://github.com/prabhakar267/github_email
email github github-email pypi pypi-packages python
Last synced: 9 months ago
JSON representation
:mag_right: Python package to get email ID of any GitHub user even if they are not public
- Host: GitHub
- URL: https://github.com/prabhakar267/github_email
- Owner: prabhakar267
- License: mit
- Created: 2016-06-25T12:11:45.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2021-05-14T21:27:32.000Z (over 4 years ago)
- Last Synced: 2025-03-26T09:04:11.230Z (10 months ago)
- Topics: email, github, github-email, pypi, pypi-packages, python
- Language: Python
- Homepage: https://pypi.python.org/pypi/github_email/
- Size: 78.1 KB
- Stars: 27
- Watchers: 2
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# github_email
[](https://badge.fury.io/py/github_email)
[](http://doge.mit-license.org)
Get a list of email IDs of any valid GitHub user from one function call **even if there are no public emails** for that user
It checks for all the public commits of the user and if the name of the author of commit is same as the name of user, it fetches that email ID.
## Installation
### Using pip
```pip
pip install github_email
```
### Using Git
```
git clone https://github.com/prabhakar267/github_email.git
cd github_email
python setup.py install
```
## Usage
```python
import github_email
# get JSON response for user
response = github_email.get(, )
if response['success']:
# prints a list of emails retrieved from public commits of user
print response['email']
else:
# prints the error message related to any error that occured
print response['message']
```
## Example
## Inspiration
[**github-email**](https://github.com/paulirish/github-email) by `paulirish`
I wanted to write a module, so as to use this in other projects