Skip to content

Brandeis-Library/Website_Scraper_Faculty_Guide

Repository files navigation

{Website_Scraper_Faculty_Guide}

{Goal of the project is to scrape the Brandeis Faculty Guide for data that will be used in our Ex Libris Esploro Implementation }, {4/13/2020}

By {Chris Underwood, Library Applicaiton Developer, Brandeis University}

Description

_{The application is in two parts. The first is in the researcher_URLs folder. The index.js goes out to each A-Z page in the Brandeis Faculty Guide (URLsToScrape.js) and scrapes the URL for all of the researchers on that page. After some data formatting and cleanup and URLs are placed in userURLs.js. The page is properly formated to be used as an exported file in node upon completion.

The second part is in researcher*data and goes to each page in a queue that is in researche_URLs/userUseLs. The program scrapes the sections defined in the body of a callback function and prints the XML in the saved.xml file. There is cleanup done on most sections to remove/modify the 5 reserved XML symbols (&, <,>, ', "). Title of selected sections are also removed. XML definition and root element are provided automatically.

Recent updates:

  • Emptying saved.xml userURLs.js automatically every time the program is run removing the need for a manual deletion.
  • Adding auto stop functionality when the list is finished vs the previous timer
  • Putting URLs for test scraping in a testing file which can be accessing by uncommenting a line researcher_data/index.js

}*

Setup/Installation Requirements

  • Make sure you have Node.js installed globally
  • Clone or fork the files to a location of your choice
  • Go to the folder/location of the download or where you have moved the files
  • Run npm i
  • Put the starting sites that you want to scrape in URLsToScrape.js. This is pre-filled for the Brandies project.
  • Change you terminal to /researcher_URLs
  • Type node index.js to start scraping the A-Z lists in the Brandeis Faculty Guide.
  • You will know this is completed when the command line shows.
  • In researcher_data/index.js in the else of the callback function customize what part of the webpages you want to make part of the XML.
  • Go to /researcher_data on the terminal.
  • On the command line run node index.js
  • You will know this is completed when the command line shows.
  • Go to saved.xml to see your scraping results. A good test is to open Oxygen or another XML editor to see if the results are in valid XML format. Text editors such as VScode will not validate as thoroughly as XML editors will.
  • Profit!

Known Bugs

{ None that I am aware of. }

Support and contact details

{ npm crawler documentation: https://www.npmjs.com/package/crawler, libsys-group at brandeis dot edu }

Technologies Used

{Crawler (via NPM), cheerio, Node.js, vanilla JavaScript, XML, and Regular Expressions }

License

*{MIT License

Copyright (c) [2020][brandeis university library]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.}*

Copyright (c) 2020 {Chris Underwood, Library Applicaiton Developer, Brandeis University}

About

Scraping the Brandeis Faculty Guide for data with our ExLibris Esploro migration.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published