https://github.com/headzoo/surf

Stateful programmatic web browsing in Go.
https://github.com/headzoo/surf

Last synced: 28 days ago
JSON representation

Stateful programmatic web browsing in Go.

• Host: GitHub
• URL: https://github.com/headzoo/surf
• Owner: headzoo
• License: mit
• Created: 2014-08-25T06:29:53.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2024-01-24T19:54:47.000Z (10 months ago)
• Last Synced: 2024-10-09T00:55:21.407Z (about 1 month ago)
• Language: Go
• Size: 502 KB
• Stars: 1,486
• Watchers: 35
• Forks: 159
• Open Issues: 56
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
Surf

====

[![Build Status](https://img.shields.io/travis/headzoo/surf/master.svg?style=flat-square)](https://travis-ci.org/headzoo/surf)

[![GoDoc](https://godoc.org/github.com/headzoo/surf?status.svg)](http://godoc.org/github.com/headzoo/surf)

[![Documentation](https://img.shields.io/badge/documentation-readthedocs-blue.svg?style=flat-square)](http://surf.readthedocs.io/)

[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://raw.githubusercontent.com/headzoo/surf/master/LICENSE.md)

Surf is a Go (golang) library that implements a virtual web browser that you control programmatically.

Surf isn't just another Go solution for downloading content from the web. Surf is designed to behave

like web browser, and includes: cookie management, history, bookmarking, user agent spoofing

(with a nifty user agent builder), submitting forms, DOM selection and traversal via jQuery style

CSS selectors, scraping assets like images, stylesheets, and other features.

* [Installation](#installation)

* [General Usage](#quick-start)

* [Documentation](#documentation)

* [Credits](#credits)

* [Contributing](#contributing)

* [License](#license)

### Installation

Download the library using go.

`go get gopkg.in/headzoo/surf.v1`

Import the library into your project.

`import "gopkg.in/headzoo/surf.v1"`

### Quick Start

```go

package main

import (

	"gopkg.in/headzoo/surf.v1"

	"fmt"

)

func main() {

	bow := surf.NewBrowser()

	err := bow.Open("http://golang.org")

	if err != nil {

		panic(err)

	}

	// Outputs: "The Go Programming Language"

	fmt.Println(bow.Title())

}

```

### Documentation

Complete documentation is available on [Read the Docs](http://surf.readthedocs.io/).

### Credits

Surf uses the awesome [goquery](https://github.com/PuerkitoBio/goquery) by Martin Angers, and

was written using [Intellij](http://www.jetbrains.com/idea/) and

the [golang plugin](http://plugins.jetbrains.com/plugin/5047).

Contributions have been made to Surf by the following awesome developers:

* [Sean Hickey](https://github.com/headzoo)

* [Haruyama Seigo](https://github.com/haruyama)

* [Tatsushi Demachi](https://github.com/tatsushid)

* [Charl Matthee](https://github.com/charl)

* [Matt Holt](https://github.com/mholt)

* [lalyos](https://github.com/lalyos)

* [lestrrat](https://github.com/lestrrat)

* [Carl Henrik Lunde](https://github.com/chlunde)

* [cornerot](https://github.com/cornerot)

* [lennyxc](https://github.com/lennyxc)

* [tlianza](https://github.com/tlianza)

* [joshuamorris3](https://github.com/joshuamorris3)

* [sqs](https://github.com/sqs)

* [nicot](https://github.com/nicot)

* [Joseph Watson](https://github.com/jtwatson)

* [lxt2](https://github.com/lxt2)

The idea to create Surf was born in [this Reddit thread](http://www.reddit.com/r/golang/comments/2efw1q/mechanize_in_go/cjz4lze).

### Contributing

Issues and pull requests are _always_ welcome.

See [CONTRIBUTING.md](https://raw.githubusercontent.com/headzoo/surf/master/CONTRIBUTING.md) for more information.

### License

Surf is released open source software released under The MIT License (MIT).

See [LICENSE.md](https://raw.githubusercontent.com/headzoo/surf/master/LICENSE.md) for more information.