jaydee 0.1.3

Crawl and scrape websites with a given .json schema.

Jaydee

Crawl websites and scrape HTML documents using a .json file schema.

Installation

Make sure you have playwright installed with:

$ pip install playwright
$ playwright install

Currently Jaydee runs on chromium so make sure that playwright at least installs that as a webdriver.

Afterwards install Jaydee from PIP:

$ pip install jaydee

Usage

More in-depth usage examples can be found in the examples directory.

Crawling:

import asyncio

from jaydee.crawler import Crawler


async def main():
    # on_proceed is called once the crawlers url queue is empty.
    def on_proceed(crawler):
        # Add pages after crawler has extracted links.
        # this page is only added once since crawler keeps track of pages it has visited.
        crawler.add_url("https://www.example.com/foo")

    crawler = Crawler(
        "https://www.example.com",
        on_proceed,
    )

    async for result in crawler.start():
        print(f"Metadata: {result["metadata"]}")
        print(f"Links found: {result["links"]}")


def start():
    asyncio.run(main())

Scraping example with requests:

import requests

from jaydee import Scraper

# Retrieve an HTML document.
r = requests.get("https://example.com")

# Setup the scraper with rules according to a .json file.
scraper = Scraper(html_doc=r.content).from_json("data/rules.json")

# Get a result
result = scraper.scrape()

License

This repository is licensed under the MIT license.