scrape-up 1.0.0

A web-scraping-based python package that enables you to scrape data from various platforms.

How to use this package? 👀

• Install the package from pip

pip install scrape-up

• Scrape the required information, for example one want to extract number of followers of a user.

# Import the required module
from scrape_up import github

# Instantiate an object with username provided.
user = github.User(username="nikhil25803")

# Cal the followers function
print(user.followers())

# Output - '59'

---

The platforms and methods we cover 💫

GitHub

from scrape_up import github

Scrape User details

First create an object of class User

user = github.Users(username="nikhil25803")

Methods	Details
.followers()	Returns the number of followers of a user.
.following()	Returns the number of following of a user.
.get_avatar()	Returns the avatar url of a user.
.get_bio()	Returns the bio of a user.
.get_repo()	Returns the list of pinned repositories for a user.
.repo_count()	Returns the number of Repositories of a user.
.star_count()	Returns the number of stars of a user.
.get_yearly_contributions()	Returns the number of contributions made in 365 days frame.
.get_repositories()	Returns the list of repositories of a user.
.get_starred_repos()	Return the list of starred repositories of a user.
.pul_requests()	Return the number of pull requests opened in a repository.
.get_followers()	Returns the list of followers of a user.
.get_following_users()	Returns the list of users followed by a user.
.get_achievements()	Returns the list of achievements of an user.
.get_status()	Returns the status of an user.

---

Scrape Repository details

First create an object of class Repository

repository = github.Repository(username="nikhil25803", repository_name="scrape-up")

Methods	Details
.fork_count()	Returns the number of forks of a repository.
.get_contributors()	Returns the number of contributors of a repository.
.topics()	Returns the topics of a repository.
.pull_requests()	Returns the number of pull requests opened in a repository.
.tags()	Returns the last ten tags of a repository.
.releases()	Returns the last ten releases of a repository.
.issues_count()	Returns number of issues in a repository
.readme	Saves the readme.md file of given user to current working directory. To view the readme.md with live server, change ".md" to ".html" in "readme.md".
.get_pull_requests_ids()	Returns all id's of opened pull requests in a repository.
.get_issues()	Returns list of all open issues in a repository.
.commits()	Returns number of commits in a repository.

---

Scrape an issue details

First create an object of class Issue

repository = github.Issue(username="nikhil25803", repository_name="scrape-up", issue_number=59)

Methods	Details
.assignees()	Returns the assignees of an issue.
.labels()	Returns the labels of an issue.
.opened_by()	Returns the name of the user, who opened the issue.
.title()	Returns the title of an issue.
.is_milestone()	Returns the milestone, if the issue is part of one or 'No milestone', if it's not.
.opened_at()	Returns a string containing the time when the issue was opened in ISO format.

---

Scrape a pull request details

First create an object of class PullRequest

repository = github.PullRequest(username="nikhil25803", repository_name="scrape-up", pull_request_number=30)

Methods	Details
.commits()	Returns the number of commits made in a pull request.
.title()	Returns the title of a pull request.
.labels()	Returns all the labels of a pull request,empty list in case of no labels.
.files_changed()	Returns the number of files changed in a pull request.
.reviewers()	Return the list of reviewers assigned in a pull request.

---

Scrape the details of an organization

First create an object of class Organization

repository = github.Organization(organization_name="Clueless-Community")

Methods	Details
.top_topics()	Returns list of the most used topics in an organization.
.followers()	Returns the number of followers of an organization.
.top_languages()	Returns the top languages used in an organization.
.followers()	Returns the number of followers of an organization.
.avatar()	Returns the avatar url of an organization.
.repositories()	Returns the list of repositories of an organization.
.people()	Returns the list of people in an organization.
.peoples()	Returns the number of people in a organization.
.repository_details()	Returns the list of repositories with their details.