crawler

README

crawler

A simple web crawler, implemented in Go

Description

Implementation of a simple concurrent web crawler using Go. Given a starting URL, the crawler visits each URL it found on the same domain. It prints each visited URL, and a list of links found on that page. The crawler is limited to one subdomain. So when it starts with https://www.github.com/, it crawls all pages within github.com, but not follows external links, for example to youtube.com or docs.github.com.

Example of usage:

package main

import (
	"os"
	"runtime"

	"github.com/vyeve/crawler"
)

func init() {
	runtime.GOMAXPROCS(runtime.NumCPU())
}

func main() {
	siteName := "https://github.com/"

	st, err := crawler.New(siteName)
	if err != nil {
		panic(err)
	}
	st.Crawl().Print(os.Stdout)
}

More examples can be found by link

Test coverage

To see test coverage run:

go test -v -tags=unit -coverprofile=cover.out && go tool cover -func=cover.out >> test.out && go tool cover -html=cover.out

Documentation

Index

• type Crawler
  • func New(initLink string) (Crawler, error)
• type Printer

Types

type Crawler

type Crawler interface {
	Crawl() Printer
}

Crawler scans link and returns Printer

func New

func New(initLink string) (Crawler, error)

New initialize Crawler

type Printer

type Printer interface {
	Print(io.Writer) error
}

Printer represents scanned links to io.Writer