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 followed but not following back
  • Number of followers not followed
  • Check number of repositories
  • List available repositories (public)

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 it using any of the following:

Step 1:
from akinyeleib import github_scrape
from akinyeleib import github_scrape 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:

getRepos()
getDetails()
getUserName()
getFollowing()
getFollowers()
getFollowersCount()
getFollowingCount()
getFollowingNotFollowers()
getFollowersNotFollowing()

Demo


>>> from akinyeleib import github_scrape as r
>>> user1 = r.GitHub("Akinyeleib")
Account found for user: Akinyeleib
Akinyeleib has 17 repositories
Akinyeleib has 32 followers
Akinyeleib is following 35 user(s)
Akinyeleib has 10 user(s) not following back
Akinyeleib is not following 7 user(s) back
>>> user1repo = user1.getRepos()
>>> user1repo
['Lawson-To-Do-List', 'Todo-List', 'FlutterNewsApp', 'html-tic-tac-toe', 'nike-sneakers-store-app', 'tic_tac_toe', 'quiz-stopwatch', 'StopWatch', 'Projects', 'HangMan-Java', 'Therapy', 'CBTApp', 'Pedek', 'ChamsMobile', 'Data-Structures-and-Algorithms', 'Bounce', 'learning-python-2896241']
>>> user1.getFollowers()
['1AMTEDDY', 'DJTOHBEX', 'Sammygee0110', 'Paulokla', 'Stevixent', 'AyodejiOmole', 'eni01', 'Ayomidefln', 'Tobigr03', 'Sagaciousprince', 'Goldenson23', 'codetech18', 'Chimajunior', 'Vgod0', 'Lekan128', 'SamAkiode', 'crisovas', 'sofiaunnie', 'KingJoker101', 'Opeyemi86', 'Tinkapaul', 'Chee123-proj', 'TubiOb', 'DeekerD', 'lawson1000', 'xDAREY', 'lolakin', 'ayetolusamuel', 'Joshokelola', 'Ogizzy', 'imoleBytes', 'menabaddo']
>>> user1.getFollowing()
['Tinkapaul', 'Tobigr03', 'Akinsanmi23', 'Olaitanbosun', 'Themarv77', 'Oayanfe', 'Vgod0', 'Chimajunior', 'crisovas', 'papillo1', 'sofiaunnie', 'Paulokla', 'KingJoker101', 'Abdullateef1000', 'Sammygee0110', 'Chee123-proj', 'TubiOb', 'xDAREY', 'lawson1000', 'Stevixent', 'AyodejiOmole', 'codetech18', 'ochinawata01', 'Shittu-ayomide', 'SamAkiode', 'lolakin', 'eni01', 'ayetolusamuel', 'Ogizzy', 'Joshokelola', 'Mastersam07', 'menabaddo', 'Princeadeola', 'imoleBytes', 'DeekerD']
>>>

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.4.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

github_scrape-0.3.4-py3-none-any.whl (4.8 kB view details)

Uploaded Python 3

File details

Details for the file github-scrape-0.3.4.tar.gz.

File metadata

  • Download URL: github-scrape-0.3.4.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for github-scrape-0.3.4.tar.gz
Algorithm Hash digest
SHA256 2840b3c93dd5b3b09c5aaba6c361b43d2d8e681221f5eabc543708bd227af0ba
MD5 edd1eaa806a6e24cb81e6b05e670dfdb
BLAKE2b-256 a1357e32ce3f21cbbb9d700e8f1dcaf68063d7b05500f70038536cd772709fcd

See more details on using hashes here.

File details

Details for the file github_scrape-0.3.4-py3-none-any.whl.

File metadata

  • Download URL: github_scrape-0.3.4-py3-none-any.whl
  • Upload date:
  • Size: 4.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for github_scrape-0.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 3afe36bad46d8951534e6e660f01defc7b59ac2977b05742d507e0a1acf8a229
MD5 0a74a78090647c321f52b97fcf2de506
BLAKE2b-256 0ee4339f6205e237cc4ce6544df09fa3058d726e523ddac2094b76fd98652eae

See more details on using hashes here.

Supported by

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