wikipage

README

wikipage

Description

Package wikipage is a golang package that provides utility functions for retrieving informations about Wikipedia articles.

Installation

This package can be installed with the go get command:

go get github.com/negapedia/wikipage

Documentation

API documentation can be found in the associated godoc reference

Documentation

Overview

Package wikipage provides utility functions for retrieving informations about Wikipedia articles.

Index

• func NotFound(err error) (title string, ok bool)
• type RequestHandler
  • func New(lang string) (rh RequestHandler)
  • func (rh RequestHandler) From(ctx context.Context, title string) (p WikiPage, err error)
• type WikiPage

Functions

func NotFound

func NotFound(err error) (title string, ok bool)

NotFound checks if current error was issued by a page not found, if so it returns page ID and sets "ok" true, otherwise "ok" is false.

Types

type RequestHandler

type RequestHandler struct {
	// contains filtered or unexported fields
}

RequestHandler is a hub from which is possible to retrieve informations about Wikipedia articles.

func New

func New(lang string) (rh RequestHandler)

New loads or creates a RequestHandler for the specified language.

func (RequestHandler) From

func (rh RequestHandler) From(ctx context.Context, title string) (p WikiPage, err error)

From returns a WikiPage from an article Title. It's safe to use concurrently. Warning: in the worst case it can block for more than 48 hours. As such it's advised to setup a timeout with the context.

type WikiPage

type WikiPage struct {
	ID       uint32 `json:"pageid"`
	Title    string
	Abstract string `json:"Extract"`
}

WikiPage represents an article of Wikipedia.