Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tokenmill/crawling-framework

Easily crawl news portals or blog sites using Storm Crawler.
https://github.com/tokenmill/crawling-framework

crawler crawling crawling-framework elasticsearch java scraping storm storm-crawler vaadin

Last synced: 4 days ago
JSON representation

Easily crawl news portals or blog sites using Storm Crawler.

Host: GitHub
URL: https://github.com/tokenmill/crawling-framework
Owner: tokenmill
License: other
Created: 2017-09-13T10:12:37.000Z (about 7 years ago)
Default Branch: master
Last Pushed: 2022-11-15T23:31:06.000Z (almost 2 years ago)
Last Synced: 2024-05-07T18:28:17.748Z (6 months ago)
Topics: crawler, crawling, crawling-framework, elasticsearch, java, scraping, storm, storm-crawler, vaadin
Language: Java
Homepage:
Size: 918 KB
Stars: 21
Watchers: 6
Forks: 3
Open Issues: 21
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Crawling Framework

[![Maven Central](https://img.shields.io/maven-central/v/lt.tokenmill.crawling/crawling-framework.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22lt.tokenmill.crawling%22%20AND%20a:%22crawling-framework%22)
[![pipeline status](https://gitlab.com/tokenmill/crawling-framework/badges/master/pipeline.svg)](https://gitlab.com/tokenmill/crawling-framework/commits/master)

Crawling Framework aims at providing instruments to configure and run your [Storm Crawler](http://stormcrawler.net/) based crawler. It mainly aims at easing crawling of article content publishing sites like news portals or blog sites. With the help of GUI tool Crawling Framework provides you can:

1. Specify which sites to crawl.
1. Configure URL inclusion and exclusion filters, thus controlling which sections of the site will be fetched.
1. Specify which elements of the page provide information about article publication name, its title and main body.
1. Define tests which validate that extraction rules are working.

Once configuration is done the Crawling Framework runs [Storm Crawler](http://stormcrawler.net/) based crawling following the rules specified in the configuration.

## Introduction

We have recorded a video on how to setup and use Crawling Framework. Click on the image below to watch in on Youtube.

[![Crawling Framework Intro](https://img.youtube.com/vi/AvO4lmmIuis/0.jpg)](https://www.youtube.com/watch?v=AvO4lmmIuis)

## Requirements

Framework writes its configuration and stores crawled data to ElasticSearch. Before starting crawl project [install ElasticSearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/_installation.html) (Crawling Framework is tested to work with Elastic v7.x).

Crawling Framework is a Java lib which will have to be extended to run Storm Crawler topology, thus Java (JDK8, Maven) infrastructure will be needed.

### Using password protected ElasticSearch

Some providers hide ElasticSearch under authentification step (Which makes sense). Just set environment variables `ES_USERNAME` and `ES_PASSWORD` accordingly, everything else can remain the same. Authentification step will be done implicitly if proper credentials are there

## Configuring and Running a crawl

See [Crawling Framework Example](https://github.com/tokenmill/crawling-framework-example) project's documentation.

## License

Distributed under the The Apache License, Version 2.0.