tinycrawler 1.5.0

Installing TinyCrawler

pip install tinycrawler

Preview (Test case)

This is the preview of the console when running the test_base.py.

Usage example

from tinycrawler import TinyCrawler
from bs4 import BeautifulSoup


def url_validator(url:str)->bool:
    """Return if page at given url is to be downloaded."""
    if "http://www.example.com/my/path" not in url:
        return False

    return True

def file_parser(response: 'Response', logger: 'Log')->str:
    """Parse downloaded page into document to be saved.
        response: 'Response', response object from requests.models.Response
        logger: 'Log', a logger to log eventual errors or infos

        Return None if the page should not be saved.
    """

    soup = BeautifulSoup(response.text, 'lxml')

    example = soup.find("div", {"class": "example"})
    if example is None:
        return None

    return example.get_text()


my_crawler = TinyCrawler(
    use_cli=True, # True to use the command line interface, False otherwise
    directory="my_path_for_website" # Path for where to save website
)

my_crawler.load_proxies("path/to/my/proxies.json")
my_crawler.set_url_validator(url_validator)
my_crawler.set_file_parser(file_parser)

my_crawler.run("http://www.example.com/my/path/index.html")

Proxies are expected to be in the following format:

[
  {
    "ip": "89.236.17.108",
    "port": 3128,
    "type": [
      "https",
      "http"
    ]
  },
  {
    "ip": "128.199.141.151",
    "port": 3128,
    "type": [
      "https",
      "http"
    ]
  }
]

License

The software is released under the MIT license.