Skip to content
/ wpdia-go Public

Simple cli used to get the description of a given text in Wikipedia

0 stars 0 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

lescactus/wpdia-go

BranchesTags

Repository files navigation

wpdia-go Go CI goreleaser

This repository contains a simple cli written in go used to get the description of a given text in Wikipedia.

It takes in argument a given text and will retrieve the extract of page content using the TextExtracts API (https://www.mediawiki.org/wiki/Extension:TextExtracts#API).

wpdia-go allow to either return the content from Wikipedia before the first section (typically the text block before the table of contents): exintro or a given number of sentences between 1 and 10: exsentences.

Note that the TextExtracts API recommends not to use exsentences as it does not work for HTML extracts and there are many edge cases for which it doesn't exist. For example "Arm. gen. Ing. John Smith was a soldier." will be treated as 4 sentences.

Usage

wpdia-go is a simple cli used to get the description of a given text in Wikipedia.
It takes in argument a given text and will retrieve the extract of page content using the 
TextExtracts API (https://www.mediawiki.org/wiki/Extension:TextExtracts#API).

For multi-word search, enclose them using double quotes: "<multi word search>".


The source code is available at https://github.com/lescactus/wpedia-go.

Usage:
  wpdia-go [flags]

Flags:
  -i, --exintro              Return only content before the first section. Mutually exclusive with 'exsentences'. (default true)
  -s, --exsentences string   How many sentences to return from Wikipedia. Must be between 1 and 10. If > 10, then default to 10. Mutually exclusive with 'exintro'. (default "10")
  -f, --full                 Also print the page Namespace and page ID.
  -h, --help                 help for wpdia-go
  -l, --lang string          Language. This will set the API endpoint used to retrieve data. (default "en")
  -a, --logformat string     Log format. Accepted values are [text json]. (default "text")
  -e, --loglevel string      Log level verbosity. Accepted values are [debug info warn error]. (default "error")
  -o, --output string        Output type. Valid choices are [plain pretty json yaml]. (default "plain")
  -r, --random               Return a random article.
  -t, --timeout duration     Timeout value of the http client to the Wikipedia API. Examples values: '10s', '500ms' (default 15s)
  -v, --version              version for wpdia-go

Installation

Prebuilt binaries can be downloaded from the GitHub Releases section, or using a Docker image from the Github Container Registry.

Running with Docker

docker run --rm -it --name wpdia-go ghcr.io/lescactus/wpdia-go

Building

Requirements

  • Golang 1.21 or higher

From source with go

You need a working go toolchain (It has been developped and tested with go >= 1.21). Refer to the official documentation for more information (or from your Linux/Mac/Windows distribution documentation to install it from your favorite package manager).

# Clone this repository
git clone https://github.com/lescactus/wpdia-go.git && cd wpdia-go/

# Build from sources. Use the '-o' flag to change the compiled binary name
go build

# Default compiled binary is wpdia-go
# You can optionnaly move it somewhere in your $PATH to access it shell wide
./wpdia-go -h

From source with docker

If you don't have go installed but have docker, run the following command to build inside a docker container:

# Build from sources inside a docker container. Use the '-o' flag to change the compiled binary name
# Warning: the compiled binary belongs to root:root
docker run --rm -it -v "$PWD":/app -w /app golang:1.22 go build

# Default compiled binary is dict-go
# You can optionnaly move it somewhere in your $PATH to access it shell wide
./wpdia-go -h

From source with docker but built inside a docker image

If you don't want to pollute your computer with another program, this cli comes with its own docker image:

docker build -t wpdia-go .

docker run --rm wpdia-go "Rammstein"

Disambiguation pages

Sometimes the resulted page coming from Wikipedia's search is a disambiguation. To quote Wikipedia:

Disambiguation in Wikipedia is the process of resolving conflicts that arise when a potential article title is ambiguous, most often because it refers to more than one subject covered by Wikipedia, either as the main topic of an article, or as a subtopic covered by an article in addition to the article's main topic. For example, Mercury can refer to a chemical element, a planet, a Roman god, and many other things.

Disambiguation is required whenever, for a given word or phrase on which a reader might search, there is more than one existing Wikipedia article to which that word or phrase might be expected to lead. In this situation there must be a way for the reader to navigate quickly from the page that first appears to any of the other possible desired articles.

In this case, wpdia-go will print an error message asking the user to refine the query. Example:

./wpdia-go nancy
Title:
  Nancy

Extract:
  /!\ The requested page is a disambiguation page /!\

A disambiguation page is Wikipedia's way of resolving conflicts that arise when a potential article title is ambiguous - most often because it refers to more than one subject covered by Wikipedia.
For example, Mercury can refer to a chemical element, a planet, a Roman god, and many other things.

Try to refine the search in a more precise manner. Example:
	'Nancy France' instead of 'Nancy' - or 'Go verb' instead of 'Go'

When this happens, refining the query by beoing more precise will help. For example, when looking for the description of the French city of Nancy, look for Nancy France instead of simply Nancy:

$ ./wpdia-go Nancy
Title:
  Nancy

Extract:
  /!\ The requested page is a disambiguation page /!\

A disambiguation page is Wikipedia's way of resolving conflicts that arise when a potential article title is ambiguous - most often because it refers to more than one subject covered by Wikipedia.
For example, Mercury can refer to a chemical element, a planet, a Roman god, and many other things.

Try to refine the search in a more precise manner. Example:
	'Nancy France' instead of 'Nancy' - or 'Go verb' instead of 'Go'


$ ./wpdia-go "Nancy france"
Title:
  Nancy, France

Extract:
  Nancy is the prefecture of the northeastern French department of Meurthe-et-Moselle. It was the capital of the Duchy of Lorraine which was annexed by France under King Louis XV in 1766 and replaced by a province with Nancy maintained as capital. Following its rise to prominence in the Age of Enlightenment, it was nicknamed the "capital of Eastern France" in the late 19th century. The metropolitan area of Nancy had a population of 511,257 inhabitants at the 2018 census, making it the 16th-largest urban area in France and Lorraine's largest. The population of the city of Nancy proper is 104,885.
The motto of the city is Non inultus premor, Latin for '"I am not injured unavenged"'—a reference to the thistle, which is a symbol of Lorraine. Place Stanislas, a large square built between 1752 and 1756 by architect Emmanuel Héré under the direction of Stanislaus I of Poland to link the medieval old town of Nancy and the new city built under Charles III, Duke of Lorraine in the 17th century, is now a UNESCO World Heritage Site, the first square in France to be given this distinction. The city also has many buildings listed as historical monuments and is one of the European centres of Art Nouveau thanks to the École de Nancy. Nancy is also a large university city; with the Centre Hospitalier Régional Universitaire de Brabois, the conurbation is home to one of the main health centres in Europe, renowned for its innovations in surgical robotics.

In the future, suggestions may be implemented.

Examples

Basic usage:

./wpdia-go golang
Title:
  Go (programming language)

Extract:
  Go is a statically typed, compiled programming language designed at Google by Robert Griesemer, Rob Pike, and Ken Thompson. It is syntactically similar to C, but with memory safety, garbage collection, structural typing, and CSP-style concurrency. It is often referred to as Golang because of its former domain name, golang.org, but its proper name is Go.There are two major implementations:

Google's self-hosting "gc" compiler toolchain, targeting multiple operating systems and WebAssembly.
gofrontend, a frontend to other compilers, with the libgo library. With GCC the combination is gccgo; with LLVM the combination is gollvm.A third-party source-to-source compiler, GopherJS, compiles Go to JavaScript for front-end web development.

Change language

./wpdia-go --lang fr golang
Title:
  Go (langage)

Extract:
  Go est un langage de programmation compilé et concurrent inspiré de C et Pascal. Ce langage a été développé par Google à partir d’un concept initial de Robert Griesemer, Rob Pike et Ken Thompson. Go possède deux implémentations : la première utilise gc, le compilateur Go ; la seconde utilise gccgo, « frontend » GCC écrit en C++. Go est écrit en C en utilisant yacc et GNU Bison pour l’analyse syntaxique jusqu’à la version 1.4, et en Go lui-même pour les versions suivantes (1.5).

Un objectif de Go est donné par Rob Pike, l’un de ses trois créateurs, qui dit à propos des développeurs inexpérimentés :

« Ils ne sont pas capables de comprendre un langage brillant, mais nous voulons les amener à réaliser de bons programmes. Ainsi, le langage que nous leur donnons doit être facile à comprendre et facile à adopter »

Go veut faciliter et accélérer la programmation à grande échelle : en raison de sa simplicité, il est donc concevable de l’utiliser aussi bien pour écrire des applications, des scripts ou de grands systèmes. Cette simplicité est nécessaire aussi pour assurer la maintenance et l’évolution des programmes sur plusieurs générations de développeurs.
S’il vise aussi la rapidité d’exécution, indispensable à la programmation système, il considère le multithreading comme le moyen le plus robuste d’assurer sur les processeurs actuels cette rapidité tout en rendant la maintenance facile par séparation de tâches simples exécutées indépendamment afin d’éviter de créer des « usines à gaz ». Cette conception permet également le fonctionnement sans réécriture sur des architectures multi-cœurs en exploitant immédiatement l’augmentation de puissance correspondante.

./wpdia-go --lang it golang
Title:
  Go (linguaggio di programmazione)

Extract:
  Go è un linguaggio di programmazione open source sviluppato da Google.
Il lavoro su Go nacque nel settembre 2007 da Robert Griesemer, Rob Pike e Ken Thompson basandosi su un precedente lavoro correlato con il sistema operativo Inferno.
Secondo gli autori, l'esigenza di creare un nuovo linguaggio di programmazione nasce dal fatto che non esiste un linguaggio di programmazione che soddisfi le esigenze di una compilazione efficiente, di un'esecuzione veloce e di una facilità di programmazione.
Go viene annunciato ufficialmente nel novembre 2009.

./wpdia-go --lang es golang
Title:
  Go (lenguaje de programación)

Extract:
  Go es un lenguaje de programación concurrente y compilado inspirado en la sintaxis de C, que intenta ser dinámico como Python y con el rendimiento de C o C++. Ha sido desarrollado por Google[9]​ y sus diseñadores iniciales fueron Robert Griesemer, Rob Pike y Ken Thompson. [10]​ Actualmente está disponible en formato binario para los sistemas operativos Windows, GNU/Linux, FreeBSD  y Mac OS X, pudiendo también ser instalado en estos y en otros sistemas mediante el código fuente.[11]​[12]​ Go es un lenguaje de programación compilado, concurrente, imperativo, estructurado, orientado a objetos y con recolector de basura que de momento es soportado en diferentes tipos de sistemas UNIX, incluidos Linux, FreeBSD, Mac OS X y Plan 9 (puesto que parte del compilador está basado en un trabajo previo sobre el sistema operativo Inferno). Las arquitecturas soportadas son i386, amd64 y ARM.

Return only the first 2 sentences

./wpdia-go -s 2 golang
Title:
  Go (programming language)

Extract:
  Go is a statically typed, compiled programming language designed at Google by Robert Griesemer, Rob Pike, and Ken Thompson. It is syntactically similar to C, but with memory safety, garbage collection, structural typing, and CSP-style concurrency.

Pretty output

./wpdia-go --output pretty golang

  ## Go (programming language)                                                                    


  Go is a statically typed, compiled programming language designed at Google by Robert Griesemer, 
  Rob Pike, and Ken Thompson. It is syntactically similar to C, but with memory safety, garbage   
  collection, structural typing, and CSP-style concurrency. It is often referred to as Golang     
  because of its former domain name, golang.org, but its proper name is Go.There are two major    
  implementations:                                                                                
                                                                                                  
  Google's self-hosting "gc" compiler toolchain, targeting multiple operating systems and         
  WebAssembly. gofrontend, a frontend to other compilers, with the libgo library. With GCC the    
  combination is gccgo; with LLVM the combination is gollvm.A third-party source-to-source compiler,
  GopherJS, compiles Go to JavaScript for front-end web development.

Json output

./wpdia-go --output json golang  
{
    "title": "Go (programming language)",
    "extract": "Go is a statically typed, compiled programming language designed at Google by Robert Griesemer, Rob Pike, and Ken Thompson. It is syntactically similar to C, but with memory safety, garbage collection, structural typing, and CSP-style concurrency. It is often referred to as Golang because of its former domain name, golang.org, but its proper name is Go.There are two major implementations:\n\nGoogle's self-hosting \"gc\" compiler toolchain, targeting multiple operating systems and WebAssembly.\ngofrontend, a frontend to other compilers, with the libgo library. With GCC the combination is gccgo; with LLVM the combination is gollvm.A third-party source-to-source compiler, GopherJS, compiles Go to JavaScript for front-end web development."
}

Yaml output

title: Go (programming language)
extract: |-
  Go is a statically typed, compiled programming language designed at Google by Robert Griesemer, Rob Pike, and Ken Thompson. It is syntactically similar to C, but with memory safety, garbage collection, structural typing, and CSP-style concurrency. It is often referred to as Golang because of its former domain name, golang.org, but its proper name is Go.There are two major implementations:

  Google's self-hosting "gc" compiler toolchain, targeting multiple operating systems and WebAssembly.
  gofrontend, a frontend to other compilers, with the libgo library. With GCC the combination is gccgo; with LLVM the combination is gollvm.A third-party source-to-source compiler, GopherJS, compiles Go to JavaScript for front-end web development.

HTTP client timeout set to 3 seconds

./wpdia-go --timeout 3s golang    
Title:
  Go (programming language)

Extract:
  Go is a statically typed, compiled programming language designed at Google by Robert Griesemer, Rob Pike, and Ken Thompson. It is syntactically similar to C, but with memory safety, garbage collection, structural typing, and CSP-style concurrency. It is often referred to as Golang because of its former domain name, golang.org, but its proper name is Go.There are two major implementations:

Google's self-hosting "gc" compiler toolchain, targeting multiple operating systems and WebAssembly.
gofrontend, a frontend to other compilers, with the libgo library. With GCC the combination is gccgo; with LLVM the combination is gollvm.A third-party source-to-source compiler, GopherJS, compiles Go to JavaScript for front-end web development.

Output the page namespace, page id and page properties

./wpedia-go golang --full
Title:
  Go (programming language)

Ns:
  0

Pageid:
  25039021

WikiBase Short Description:
  Programming language

WikiBase Item:
  Q37227

Extract:
  Go is a statically typed, compiled programming language designed at Google by Robert Griesemer, Rob Pike, and Ken Thompson. It is syntactically similar to C, but with memory safety, garbage collection, structural typing, and CSP-style concurrency. It is often referred to as Golang because of its former domain name, golang.org, but its proper name is Go.There are two major implementations:

Google's self-hosting "gc" compiler toolchain, targeting multiple operating systems and WebAssembly.
gofrontend, a frontend to other compilers, with the libgo library. With GCC the combination is gccgo; with LLVM the combination is gollvm.A third-party source-to-source compiler, GopherJS, compiles Go to JavaScript for front-end web development.

Info level logging

INFO[2022-05-02T10:10:54+02:00] Creating new Wiki client...                   fields.level=info url="https://en.wikipedia.org/w/api.php"
INFO[2022-05-02T10:10:54+02:00] Searching title...                            fields.level=info title=golang
INFO[2022-05-02T10:10:55+02:00] Getting text extract...                       fields.level=info id=25039021 title=golang
Title:
  Go (programming language)

Extract:
  Go is a statically typed, compiled programming language designed at Google by Robert Griesemer, Rob Pike, and Ken Thompson. It is syntactically similar to C, but with memory safety, garbage collection, structural typing, and CSP-style concurrency. It is often referred to as Golang because of its former domain name, golang.org, but its proper name is Go.There are two major implementations:

Google's self-hosting "gc" compiler toolchain, targeting multiple operating systems and WebAssembly.
gofrontend, a frontend to other compilers, with the libgo library. With GCC the combination is gccgo; with LLVM the combination is gollvm.A third-party source-to-source compiler, GopherJS, compiles Go to JavaScript for front-end web development.

Debug level logging

INFO[2022-05-02T10:11:11+02:00]/home/amaldeme/gitclone/wpdia-go/cmd/root.go:68 github.com/lescactus/wpdia-go/cmd.glob..func1() Creating new Wiki client...                   fields.level=debug url="https://en.wikipedia.org/w/api.php"
DEBU[2022-05-02T10:11:11+02:00]/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:38 github.com/lescactus/wpdia-go/cmd.NewWikiClient() Parsing base URL...                           fields.level=debug url="https://en.wikipedia.org/w/api.php"
DEBU[2022-05-02T10:11:11+02:00]/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:49 github.com/lescactus/wpdia-go/cmd.NewWikiClient() Base URL Parsed                               fields.level=debug url="https://en.wikipedia.org/w/api.php"
DEBU[2022-05-02T10:11:11+02:00]/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:63 github.com/lescactus/wpdia-go/cmd.NewWikiClient() User-Agent set                                User-Agent="wpdia-go/0.0.8 (github.com/lescactus/wpdia-go) WikiClient/0.0.8" fields.level=debug
DEBU[2022-05-02T10:11:11+02:00]/home/amaldeme/gitclone/wpdia-go/cmd/root.go:79 github.com/lescactus/wpdia-go/cmd.glob..func1() New Wiki client created                       fields.level=debug url="https://en.wikipedia.org/w/api.php"
INFO[2022-05-02T10:11:11+02:00]/home/amaldeme/gitclone/wpdia-go/cmd/root.go:84 github.com/lescactus/wpdia-go/cmd.glob..func1() Searching title...                            fields.level=debug title=golang
DEBU[2022-05-02T10:11:11+02:00]/home/amaldeme/gitclone/wpdia-go/cmd/root.go:96 github.com/lescactus/wpdia-go/cmd.glob..func1() Title found                                   fields.level=debug title=golang
DEBU[2022-05-02T10:11:11+02:00]/home/amaldeme/gitclone/wpdia-go/cmd/root.go:110 github.com/lescactus/wpdia-go/cmd.glob..func1() Disable 'exintro'...                          fields.level=debug
INFO[2022-05-02T10:11:11+02:00]/home/amaldeme/gitclone/wpdia-go/cmd/root.go:122 github.com/lescactus/wpdia-go/cmd.glob..func1() Getting text extract...                       fields.level=debug id=25039021 title=golang
DEBU[2022-05-02T10:11:11+02:00]/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:82 github.com/lescactus/wpdia-go/cmd.(*WikiClient).GetExtract() Setting http request parameters...            fields.level=debug
DEBU[2022-05-02T10:11:11+02:00]/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:103 github.com/lescactus/wpdia-go/cmd.(*WikiClient).GetExtract() Http request parameters set                   fields.level=debug params="map[exintro:[1] explaintext:[1] exsectionformat:[plain] pageids:[25039021] prop:[extracts]]"
DEBU[2022-05-02T10:11:11+02:00]/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:110 github.com/lescactus/wpdia-go/cmd.(*WikiClient).GetExtract() Building http request...                      fields.level=debug params="map[exintro:[1] explaintext:[1] exsectionformat:[plain] pageids:[25039021] prop:[extracts]]" url="https://en.wikipedia.org/w/api.php" user-agent="wpdia-go/0.0.8 (github.com/lescactus/wpdia-go) WikiClient/0.0.8"
DEBU[2022-05-02T10:11:11+02:00]/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:123 github.com/lescactus/wpdia-go/cmd.(*WikiClient).GetExtract() Http request built                            fields.level=debug params="map[action:[query] exintro:[1] explaintext:[1] exsectionformat:[plain] format:[json] pageids:[25039021] prop:[extracts]]" url="https://en.wikipedia.org/w/api.php" user-agent="wpdia-go/0.0.8 (github.com/lescactus/wpdia-go) WikiClient/0.0.8"
DEBU[2022-05-02T10:11:11+02:00]/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:127 github.com/lescactus/wpdia-go/cmd.(*WikiClient).GetExtract() Sending http request...                       fields.level=debug
DEBU[2022-05-02T10:11:12+02:00]/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:136 github.com/lescactus/wpdia-go/cmd.(*WikiClient).GetExtract() Http request sent                             fields.level=debug
DEBU[2022-05-02T10:11:12+02:00]/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:143 github.com/lescactus/wpdia-go/cmd.(*WikiClient).GetExtract() Reading http response body and unmarshalling...  fields.level=debug
DEBU[2022-05-02T10:11:12+02:00]/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:153 github.com/lescactus/wpdia-go/cmd.(*WikiClient).GetExtract() Http response body read and unmarshalled      fields.level=debug
DEBU[2022-05-02T10:11:12+02:00]/home/amaldeme/gitclone/wpdia-go/cmd/root.go:138 github.com/lescactus/wpdia-go/cmd.glob..func1() Text extract found                            fields.level=debug id=25039021 title=golang
DEBU[2022-05-02T10:11:12+02:00]/home/amaldeme/gitclone/wpdia-go/cmd/root.go:143 github.com/lescactus/wpdia-go/cmd.glob..func1() Setting formatter...                          fields.level=debug
DEBU[2022-05-02T10:11:12+02:00]/home/amaldeme/gitclone/wpdia-go/cmd/root.go:160 github.com/lescactus/wpdia-go/cmd.glob..func1() Formatter set to plain                        fields.level=debug
Title:
  Go (programming language)

Extract:
  Go is a statically typed, compiled programming language designed at Google by Robert Griesemer, Rob Pike, and Ken Thompson. It is syntactically similar to C, but with memory safety, garbage collection, structural typing, and CSP-style concurrency. It is often referred to as Golang because of its former domain name, golang.org, but its proper name is Go.There are two major implementations:

Google's self-hosting "gc" compiler toolchain, targeting multiple operating systems and WebAssembly.
gofrontend, a frontend to other compilers, with the libgo library. With GCC the combination is gccgo; with LLVM the combination is gollvm.A third-party source-to-source compiler, GopherJS, compiles Go to JavaScript for front-end web development.

Json logging

{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/root.go:80","func":"github.com/lescactus/wpdia-go/cmd.glob..func1","level":"info","msg":"Creating new Wiki client...","time":"2022-05-03T11:27:57+02:00","url":"https://en.wikipedia.org/w/api.php"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:38","func":"github.com/lescactus/wpdia-go/cmd.NewWikiClient","level":"debug","msg":"Parsing base URL...","time":"2022-05-03T11:27:57+02:00","url":"https://en.wikipedia.org/w/api.php"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:49","func":"github.com/lescactus/wpdia-go/cmd.NewWikiClient","level":"debug","msg":"Base URL Parsed","time":"2022-05-03T11:27:57+02:00","url":"https://en.wikipedia.org/w/api.php"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:63","func":"github.com/lescactus/wpdia-go/cmd.NewWikiClient","level":"debug","msg":"User-Agent set","time":"2022-05-03T11:27:57+02:00","user-agent":"wpdia-go/0.1.0 (github.com/lescactus/wpdia-go) WikiClient/0.1.0"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/root.go:95","func":"github.com/lescactus/wpdia-go/cmd.glob..func1","level":"debug","msg":"New Wiki client created","time":"2022-05-03T11:27:57+02:00","url":"https://en.wikipedia.org/w/api.php"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/root.go:99","func":"github.com/lescactus/wpdia-go/cmd.glob..func1","level":"debug","msg":"Disabling 'exintro'...","time":"2022-05-03T11:27:57+02:00"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/root.go:111","func":"github.com/lescactus/wpdia-go/cmd.glob..func1","level":"info","msg":"Getting text extract...","random":false,"time":"2022-05-03T11:27:57+02:00","title":"golang"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/root.go:121","func":"github.com/lescactus/wpdia-go/cmd.glob..func1","level":"info","msg":"Searching title...","time":"2022-05-03T11:27:57+02:00","title":"golang"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:206","func":"github.com/lescactus/wpdia-go/cmd.(*WikiClient).SearchTitle","level":"debug","msg":"Http request parameters set","params":{"list":["search"],"srlimit":["1"],"srsearch":["golang"],"utf8":["1"]},"time":"2022-05-03T11:27:57+02:00"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:213","func":"github.com/lescactus/wpdia-go/cmd.(*WikiClient).SearchTitle","level":"debug","msg":"Building http request...","params":{"list":["search"],"srlimit":["1"],"srsearch":["golang"],"utf8":["1"]},"time":"2022-05-03T11:27:57+02:00","url":"https://en.wikipedia.org/w/api.php","user-agent":"wpdia-go/0.1.0 (github.com/lescactus/wpdia-go) WikiClient/0.1.0"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:226","func":"github.com/lescactus/wpdia-go/cmd.(*WikiClient).SearchTitle","level":"debug","msg":"Http request built","params":{"action":["query"],"format":["json"],"list":["search"],"srlimit":["1"],"srsearch":["golang"],"utf8":["1"]},"time":"2022-05-03T11:27:57+02:00","url":"https://en.wikipedia.org/w/api.php","user-agent":"wpdia-go/0.1.0 (github.com/lescactus/wpdia-go) WikiClient/0.1.0"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:230","func":"github.com/lescactus/wpdia-go/cmd.(*WikiClient).SearchTitle","level":"debug","msg":"Sending http request...","time":"2022-05-03T11:27:57+02:00"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:239","func":"github.com/lescactus/wpdia-go/cmd.(*WikiClient).SearchTitle","level":"debug","msg":"Http request sent","time":"2022-05-03T11:27:57+02:00"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:243","func":"github.com/lescactus/wpdia-go/cmd.(*WikiClient).SearchTitle","level":"debug","msg":"Reading http response body and unmarshalling...","time":"2022-05-03T11:27:57+02:00"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:256","func":"github.com/lescactus/wpdia-go/cmd.(*WikiClient).SearchTitle","level":"debug","msg":"Http response body read and unmarshalled","time":"2022-05-03T11:27:57+02:00"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:269","func":"github.com/lescactus/wpdia-go/cmd.(*WikiClient).SearchTitle","level":"info","msg":"Search found a Page ID","pageid":25039021,"time":"2022-05-03T11:27:57+02:00"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/root.go:139","func":"github.com/lescactus/wpdia-go/cmd.glob..func1","level":"debug","msg":"Title found","time":"2022-05-03T11:27:57+02:00","title":"golang"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:82","func":"github.com/lescactus/wpdia-go/cmd.(*WikiClient).GetExtract","level":"debug","msg":"Setting http request parameters...","time":"2022-05-03T11:27:57+02:00"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:90","func":"github.com/lescactus/wpdia-go/cmd.(*WikiClient).GetExtract","level":"debug","msg":"Http request parameters set","params":{"exintro":["1"],"explaintext":["1"],"exsectionformat":["plain"],"pageids":["25039021"],"prop":["extracts|pageprops"]},"time":"2022-05-03T11:27:57+02:00"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:133","func":"github.com/lescactus/wpdia-go/cmd.(*WikiClient).do","level":"debug","msg":"Building http request...","params":{"exintro":["1"],"explaintext":["1"],"exsectionformat":["plain"],"pageids":["25039021"],"prop":["extracts|pageprops"]},"time":"2022-05-03T11:27:57+02:00","url":"https://en.wikipedia.org/w/api.php","user-agent":"wpdia-go/0.1.0 (github.com/lescactus/wpdia-go) WikiClient/0.1.0"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:146","func":"github.com/lescactus/wpdia-go/cmd.(*WikiClient).do","level":"debug","msg":"Http request built","params":{"action":["query"],"exintro":["1"],"explaintext":["1"],"exsectionformat":["plain"],"format":["json"],"pageids":["25039021"],"prop":["extracts|pageprops"]},"time":"2022-05-03T11:27:57+02:00","url":"https://en.wikipedia.org/w/api.php","user-agent":"wpdia-go/0.1.0 (github.com/lescactus/wpdia-go) WikiClient/0.1.0"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:150","func":"github.com/lescactus/wpdia-go/cmd.(*WikiClient).do","level":"debug","msg":"Sending http request...","time":"2022-05-03T11:27:57+02:00"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:160","func":"github.com/lescactus/wpdia-go/cmd.(*WikiClient).do","level":"debug","msg":"Http request sent","time":"2022-05-03T11:27:58+02:00"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:167","func":"github.com/lescactus/wpdia-go/cmd.(*WikiClient).do","level":"debug","msg":"Reading http response body and unmarshalling...","time":"2022-05-03T11:27:58+02:00"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:177","func":"github.com/lescactus/wpdia-go/cmd.(*WikiClient).do","level":"debug","msg":"Http response body read and unmarshalled","time":"2022-05-03T11:27:58+02:00"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/root.go:169","func":"github.com/lescactus/wpdia-go/cmd.glob..func1","level":"debug","msg":"Text extract found","random":false,"time":"2022-05-03T11:27:58+02:00","title":"golang"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/root.go:207","func":"github.com/lescactus/wpdia-go/cmd.glob..func1","level":"debug","msg":"Setting formatter...","time":"2022-05-03T11:27:58+02:00"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/root.go:224","func":"github.com/lescactus/wpdia-go/cmd.glob..func1","level":"debug","msg":"Formatter set to plain","time":"2022-05-03T11:27:58+02:00"}
Title:
  Go (programming language)

Extract:
  Go is a statically typed, compiled programming language designed at Google by Robert Griesemer, Rob Pike, and Ken Thompson. It is syntactically similar to C, but with memory safety, garbage collection, structural typing, and CSP-style concurrency. It is often referred to as Golang because of its former domain name, golang.org, but its proper name is Go.There are two major implementations:

Google's self-hosting "gc" compiler toolchain, targeting multiple operating systems and WebAssembly.
gofrontend, a frontend to other compilers, with the libgo library. With GCC the combination is gccgo; with LLVM the combination is gollvm.A third-party source-to-source compiler, GopherJS, compiles Go to JavaScript for front-end web development.

Random article

./wpdia-go --random
Title:
  John Matoian

Extract:
  John Matoian (born 1949) is a businessman and television industry executive. He was a vice-president of the CBS Entertainment division. He later became the president of Entertainment at Fox Broadcasting in September 1995. He was president at HBO from 1996 to 1999. He received both his B.A. and his J.D. from Duke University.
Matoian is a native of Fresno and is of Armenian descent.In the 2012 United States Presidential election, John Matoian had made $83,800 worth of contributions to Barack Obama's successful presidential campaign.In his book Springfield Confidential, Mike Reiss mentions Matoian by name as the Fox executive whose intense hatred of his and Al Jean's animated series The Critic led to its cancellation after a single season on the network.

Random article + HTTP client timeout set to 500ms + json output + only 3 sentences + French language + full output + log level debug + log format json

./wpdia-go -t 500ms --output json --exsentences 3 --lang fr --full --loglevel debug --logformat json --random
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/root.go:80","func":"github.com/lescactus/wpdia-go/cmd.glob..func1","level":"info","msg":"Creating new Wiki client...","time":"2022-05-03T11:27:06+02:00","url":"https://fr.wikipedia.org/w/api.php"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:38","func":"github.com/lescactus/wpdia-go/cmd.NewWikiClient","level":"debug","msg":"Parsing base URL...","time":"2022-05-03T11:27:06+02:00","url":"https://fr.wikipedia.org/w/api.php"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:49","func":"github.com/lescactus/wpdia-go/cmd.NewWikiClient","level":"debug","msg":"Base URL Parsed","time":"2022-05-03T11:27:06+02:00","url":"https://fr.wikipedia.org/w/api.php"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:63","func":"github.com/lescactus/wpdia-go/cmd.NewWikiClient","level":"debug","msg":"User-Agent set","time":"2022-05-03T11:27:06+02:00","user-agent":"wpdia-go/0.1.0 (github.com/lescactus/wpdia-go) WikiClient/0.1.0"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/root.go:95","func":"github.com/lescactus/wpdia-go/cmd.glob..func1","level":"debug","msg":"New Wiki client created","time":"2022-05-03T11:27:06+02:00","url":"https://fr.wikipedia.org/w/api.php"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/root.go:99","func":"github.com/lescactus/wpdia-go/cmd.glob..func1","level":"debug","msg":"Disabling 'exintro'...","time":"2022-05-03T11:27:06+02:00"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/root.go:111","func":"github.com/lescactus/wpdia-go/cmd.glob..func1","level":"info","msg":"Getting text extract...","random":true,"time":"2022-05-03T11:27:06+02:00","title":""}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:100","func":"github.com/lescactus/wpdia-go/cmd.(*WikiClient).GetExtractRandom","level":"debug","msg":"Setting http request parameters...","time":"2022-05-03T11:27:06+02:00"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:116","func":"github.com/lescactus/wpdia-go/cmd.(*WikiClient).GetExtractRandom","level":"debug","msg":"Http request parameters set","params":{"explaintext":["1"],"exsectionformat":["plain"],"exsentences":["3"],"generator":["random"],"grnlimit":["1"],"grnnamespace":["0"],"prop":["extracts|pageprops"]},"time":"2022-05-03T11:27:06+02:00"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:133","func":"github.com/lescactus/wpdia-go/cmd.(*WikiClient).do","level":"debug","msg":"Building http request...","params":{"explaintext":["1"],"exsectionformat":["plain"],"exsentences":["3"],"generator":["random"],"grnlimit":["1"],"grnnamespace":["0"],"prop":["extracts|pageprops"]},"time":"2022-05-03T11:27:06+02:00","url":"https://fr.wikipedia.org/w/api.php","user-agent":"wpdia-go/0.1.0 (github.com/lescactus/wpdia-go) WikiClient/0.1.0"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:146","func":"github.com/lescactus/wpdia-go/cmd.(*WikiClient).do","level":"debug","msg":"Http request built","params":{"action":["query"],"explaintext":["1"],"exsectionformat":["plain"],"exsentences":["3"],"format":["json"],"generator":["random"],"grnlimit":["1"],"grnnamespace":["0"],"prop":["extracts|pageprops"]},"time":"2022-05-03T11:27:06+02:00","url":"https://fr.wikipedia.org/w/api.php","user-agent":"wpdia-go/0.1.0 (github.com/lescactus/wpdia-go) WikiClient/0.1.0"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:150","func":"github.com/lescactus/wpdia-go/cmd.(*WikiClient).do","level":"debug","msg":"Sending http request...","time":"2022-05-03T11:27:06+02:00"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:160","func":"github.com/lescactus/wpdia-go/cmd.(*WikiClient).do","level":"debug","msg":"Http request sent","time":"2022-05-03T11:27:07+02:00"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:167","func":"github.com/lescactus/wpdia-go/cmd.(*WikiClient).do","level":"debug","msg":"Reading http response body and unmarshalling...","time":"2022-05-03T11:27:07+02:00"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/wpdia.go:177","func":"github.com/lescactus/wpdia-go/cmd.(*WikiClient).do","level":"debug","msg":"Http response body read and unmarshalled","time":"2022-05-03T11:27:07+02:00"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/root.go:169","func":"github.com/lescactus/wpdia-go/cmd.glob..func1","level":"debug","msg":"Text extract found","random":true,"time":"2022-05-03T11:27:07+02:00","title":""}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/root.go:207","func":"github.com/lescactus/wpdia-go/cmd.glob..func1","level":"debug","msg":"Setting formatter...","time":"2022-05-03T11:27:07+02:00"}
{"fields.level":"debug","file":"/home/amaldeme/gitclone/wpdia-go/cmd/root.go:224","func":"github.com/lescactus/wpdia-go/cmd.glob..func1","level":"debug","msg":"Formatter set to json","time":"2022-05-03T11:27:07+02:00"}
{
    "pageid": 5367493,
    "ns": 0,
    "title": "Archives Hergé",
    "extract": "Les Archives Hergé sont une série de quatre recueils de bandes dessinées, comportant les versions originales, en noir et blanc, de plusieurs albums d'Hergé. Elles sont éditées par Casterman.\n\n\nArchives Hergé Tome 1\nLe tome 1 des Archives, paru en 1973, rassemble :\n\nLes Aventures de Totor, C. P. des Hannetons\nTintin au pays des Soviets, la première aventure de Tintin.",
    "pageprops": {
        "wikibase_item": "Q2860408"
    }
}

TODO:

  • Improve display

  • Improve documentation

  • Improve http user agent

  • Avoid code duplicate in http request builder

  • Parametrize exsentences, http timeout, etc ... (flag & env variable)

  • Output flag: table, json, etc...

  • Language support

  • Implement "random article"

  • Fix 'may refer to:'

  • Add suggestions for disambiguation pages

  • Improve base url

  • Dockerize

  • Debug flag (show page id, ns, timestamps, etc...)

  • Verbose logs

About

Simple cli used to get the description of a given text in Wikipedia

Resources

Readme
Activity

Stars

0 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases 11

v0.5.0 Latest
Sep 9, 2024
+ 10 releases

Packages

 
 
 

Contributors 2

  •  
  •  

Languages