Skip to content

Latest commit

 

History

History
50 lines (47 loc) · 3.1 KB

readme.md

File metadata and controls

50 lines (47 loc) · 3.1 KB

NGScrape

Newgrounds game scraper made with beautifulsoup4 and requestslib.

NGScrape is licensed under the GNU Affero General Public License v3.0. If a copy is not included with this file, you can find one at https://www.gnu.org/licenses/agpl-3.0.en.html.

Please star is this was useful!

Functions:

  • __init__(self, debug: bool = False, cache: bool = False, parser: str = 'html.parser') -> None
    • Start a new NGScrape Instance.
      • Parameters:
        • debug (bool) = False: Enable/Disable debug mode
        • cache (bool) = False: Enable/Disable caching
        • parser (str) = 'lxml': Parser used by BS4
  • scrape_game(url: str, download: str, filename: str) -> None
    • Scrape a flash game by url. Returns the URL for the swf.
      • Parameters:
        • url (str): The URL of the flash game. For example, the URL for Alien Homonid is https://www.newgrounds.com/portal/view/59593.
      • Example parameters:
        • url = 'https://www.newgrounds.com/portal/view/59593'
      • Example output with debug mode:
        • NGScrape: Made request to https://www.newgrounds.com/portal/view/59593 and got status code 200
        • NGScrape: Found flash game link https:\/\/uploads.ungrounded.net\/59000\/59593_alien_booya.swf?f1101313499
  • scrape_desc(self, url: str) -> str
    • Scrape a flash game's description by url. Returns the description of the game.
      • Parameters:
        • url (str): The URL of the flash game. For example, the URL for Alien Homonid is https://www.newgrounds.com/portal/view/59593.
      • Example parameters:
        • url = 'https://www.newgrounds.com/portal/view/59593'
      • Example output with debug mode:
        • NGScrape: Made request to https://www.newgrounds.com/portal/view/59593 and got status code 200
        • NGScrape: Found game description "Blast FBI agents in this Metal Slug style shooter!"
  • scrape_card(self, url: str) -> str
    • Scrape a flash game's card by url. Returns the URL of the card file.
      • Parameters:
        • url (str): The URL of the flash game. For example, the URL for Alien Homonid is https://www.newgrounds.com/portal/view/59593.
      • Example parameters:
        • url = 'https://www.newgrounds.com/portal/view/59593'
      • Example output with debug mode:
        • NGScrape: Made request to https://www.newgrounds.com/portal/view/59593 and got status code 200
        • NGScrape: Found card link https://picon.ngfiles.com/59000/flash_59593_card.png?f1607717241
  • scrape_title(self, url: str) -> str
    • Scrape a flash game's title with url. Returns title of the flash game.
      • Parameters:
        • url (str): The URL of the flash game. For example, the URL for Alien Homonid is https://www.newgrounds.com/portal/view/59593.
      • Example parameters:
        • url = 'https://www.newgrounds.com/portal/view/59593'
      • Example output with debug mode:
        • NGScrape: Made request to https://www.newgrounds.com/portal/view/59593 and got status code 200
        • NGScrape: Found game title "Alien Homonid"