Metadata-Version: 2.1
Name: ghlightning
Version: 1.0.9
Summary: Github scraper.
Home-page: https://github.com/7azabet/lightning
Author: Nader Ahmed
Author-email: nad3rahm3d@gmail.com
License: MIT License
        
        Copyright (c) 2021 Nader Ahmed
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Bug Tracker, https://github.com/7azabet/lightning/issues
Keywords: ghlightning github_scrapper scrapper github info NaderAhmed nad3rahm3d
Platform: Windows
Platform: Linux
Platform: Solaris
Platform: Mac OS-X
Platform: Unix
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# Github Lightning ⚡

**ghlightning** is a very simple python package to collect all the information that can be collected about the users of the [GitHub](http://github.com) website.

## Installation

Use the package manager [pip](https://pip.pypa.io/en/stable/) to install ghlightning.

```bash
pip3 install ghlightning
```

## Usage

```python
from ghlightning import Github

test = Github("7azabet") # initializing an object.
test.email # returns the email of object if provided.
test.fetchInfo() # returns all info about user.
test.countryInfo() # returns all info about user country.
test.downloadFollowersPics() # download all followers pictures
# you can specify a path for downloading images
# default is the current path.
```

## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License
[MIT](https://choosealicense.com/licenses/mit/)

