Metadata-Version: 2.1
Name: github-scrape
Version: 0.3.0
Summary: A program to scrape github followers
Author-email: Akinyele Ibrahim <iakinyele3@gmail.com>
Project-URL: Homepage, https://github.com/akinyeleib/github-followers-scrape
Keywords: Github,scrape,check followers
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# github-scrape

### About

Scrapes github pages for a specified user,
displays a report about the user's current account status.

The report contains:
- [x] Number of followers
- [x] Number of users being followed
- [x] Number of users following but not following back
- [x] Opposite of '3.'
- [x] Check number of repositories
- [x] List repositories


## Installation
For first time installation:
'''
pip install github-scrape
'''

For recurring installation/update:
'''
pip install github-scrape --upgrade
'''

## Usage

To use the package, you have to import using any of the following:

##### Step 1:

```
from akinyeleib import reader
from akinyeleib import reader as r
```

##### Step 2:

Create an object of "Github" class
It's constructor accepts the github username as an argument
For this example, we would use username "akinyeleib"
`user1 = reader.GitHub("akinyeleib")`

Or:

`user1 = r.GitHub("akinyeleib")`

##### Step 3:

Use the object to access several methods from the class
Some of the available methods include:

```
print(f"Followers: {user1.getFollowers()}")
print(f"Following: {user1.getFollowing()}")
print("FollowersNotFollowing: " + user1.getFollowersNotFollowing())
print("FollowingNotFollowers: " + user1.getFollowingNotFollowers())
print(user1.getDetails())
```
Other methods include:
getFollowing, getFollowers, getRepos

### Thank you.
