Skip to content

Latest commit

 

History

History
92 lines (62 loc) · 2.61 KB

README.md

File metadata and controls

92 lines (62 loc) · 2.61 KB

github-domain-scraper

The github-domain-scraper is a powerful tool for extracting valuable information from GitHub domains. It provides a wide variety of use-cases, making it a versatile solution for various scenarios.

Installation

You can install the github-domain-scraper from PyPI:

python -m pip install github-domain-scraper

The reader is supported on Python 3.8 and above.

How to use

The github-domain-scraper is having wide variety of use-cases

Command-line Tool

You can use the github-domain-scraper as a command-line tool to extract information from GitHub domains:

  1. Extracting Users Repositories links

    python -m github_domain_scraper --link="https://github.com/Parth971"

    You can also specify a JSON output file for the results and maximum number of links:

    python -m github_domain_scraper \
    --link "https://github.com/Parth971" \
    --json output.json \
    --max-repositories 10

  2. Extracting links from Search result

    python -m github_domain_scraper --link "https://github.com/search?q=ori+python&type=users"

    You can also specify a JSON output file for the results and maximum number of links:

    python -m github_domain_scraper \
    --link "https://github.com/search?q=ori+python&type=users" \
    --json output.json \
    --max-repositories 10

  3. Extracting User Profile Information

    python -m github_domain_scraper --github-username <GitHub Username> [<GitHub Username>, ...]

    You can also specify a JSON output file for the results:

    python -m github_domain_scraper --github-username Parth971
    python -m github_domain_scraper \
    --github-username Parth971 OrionXV oriana04bedoya oriolval Ailothaen \
    --json output.json

Integration in Python Modules

The github-domain-scraper can also be seamlessly integrated into other Python modules. Import the LinkExtractor class from github_domain_scraper.link_extractor and use it as follows:

from github_domain_scraper.extractor import LinkExtractor, UserProfileInformationExtractor

links = LinkExtractor(initial_link="github_link").extract()
info = UserProfileInformationExtractor(github_username="Parth971").extract()

This makes it easy to incorporate github-domain-scraper functionality into your custom Python projects.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

github_domain_scraper.extractor