Skip to main content

A program to scrape github followers

Project description

github-scrape

About

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

The report contains:

  • Number of followers
  • Number of users being followed
  • Number of users following but not following back
  • Opposite of '3.'
  • Check number of repositories
  • 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

github-scrape-0.3.0.tar.gz (3.9 kB view hashes)

Uploaded Source

Built Distribution

github_scrape-0.3.0-py3-none-any.whl (4.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page