/scraper-capstone-ruby

A Github Scraping Tool developed with Ruby and the Nokogiri gem

Primary LanguageRuby

Github Scraper

A Github Scraping Tool developed with Ruby and the Nokogiri gem

ruby-capstone2 ruby-capstone3 ruby-capstone1 ![test2-capstone

My Github Scraper

Table of Contents

About The Project

This is Github Scrapping Tool built with ruby. This Tools is built as a capstone project for completing one of Microverse's Main Technical Curriculum sections.

[![Product Name Screen Shot][product-screenshot]][screenshot-url]

Installation

To use this scraper this is what you need to:

  • Have ruby installed in your computer
  • Download or clone this repo:
    • Clone with SSH:
     https://github.com/billodiallo/scraper-capstone-ruby.git
  • Clone with HTTPS 
      github.com/billodiallo/scraper-capstone-ruby.git
  • cd into scraper-capstone-ruby directory and run bundle install
  • Finally, run bin/main in your terminal.

How to use

When you first run this github scraping tool it begins by showing you the summary info output format

   Github User
  -------------------------------  
  Name: xxxxxx (xxxxxxx)  
  Bio: xxxxxx  
  Work: xxxxxx  
  Location: xxxxxx  
  Website: xxxxxx  
  ---------------------------------
  pinned Repositories
  ---------------------------------
  1. xxxxxx
  2. xxxxxx
  3. xxxxxx
  4. xxxxxx
  5. xxxxxx
  6. xxxxxx
  --------------------------------

After this, you are prompted to enter a valid github username. Then it returns the above output format with all the information filled in.

  Categories
  ---------------------------------
  repositories: xxxxxx
  stars: xxxxxx
  followers: xxxxxxx
  following: xxxxxx
  ----------------------------------

Then you will be prompted to enter a category name to see a full list of its contents. For instance enter repositories or stars, or followers or following to get a list of those scrapped categories. This will continue until you exit the program by typing 'q' in the terminal and pressing Enter.

Built With

This project was built using these technologies.

  • Ruby
  • Rspec
  • Nokogiri gem
  • Colorize gem

Testing

If you wish to test it. Install Rspecwith gem install rspec. Clone this repo to your local machine, cd into github-scraper directory and run rspec

LIVE DEMO VIDEO

https://www.loom.com/share/7c3fe4266fe14804bf0382caa08424a5

Contact

👤 Billo Dallio

Acknowledgements

📝 License

This project is MIT licensed.