xkcd.com API client in Go

Nishanth Shanmugham

Last update: Dec 24, 2022

Related tags

Public API Wrappers go-xkcd

Overview

go-xkcd

HTTP Client for the xkcd API.

Details on the xkcd API can be found here.

Install

Outside a project using go modules, get the latest version by running:

go get github.com/nishanths/go-xkcd

Inside a project using go modules, use:

go get github.com/nishanths/go-xkcd@latest

Example

The following program prints details about xkcd.com/599:

package main

import (
    "context"
    "fmt"
    "log"

    "github.com/nishanths/go-xkcd/v2"
)

func main() {
    client := xkcd.NewClient()

    comic, err := client.Get(context.Background(), 599)
    if err != nil {
        log.Fatal(err)
    }
    fmt.Printf("%s: %s\n", comic.Title, comic.ImageURL) // Apocalypse: http://imgs.xkcd.com/comics/apocalypse.png
}

Test

To run tests:

$ go test -race

Godoc

https://godoc.org/github.com/nishanths/go-xkcd

License

Balabola-go-client - GO client for Yandex balabola service

Balabola GO Client GO client for Yandex balabola service Yandex warning The neur

0 Jan 29, 2022

Client-server-golang-sqs - Client Server with SQS and golang

Client Server with SQS and golang Multi-threaded client-server demo with Go What

0 Feb 14, 2022

Go Client Library for Amazon Product Advertising API

go-amazon-product-advertising-api Go Client Library for Amazon Product Advertising API How to Use go get -u github.com/ngs/go-amazon-product-advertisi

54 Sep 27, 2022

A Go client library for the Twitter 1.1 API

Anaconda Anaconda is a simple, transparent Go package for accessing version 1.1 of the Twitter API. Successful API queries return native Go structs th

1.1k Jan 1, 2023

Go client library for interacting with Coinpaprika's API

Coinpaprika API Go Client Usage This library provides convenient way to use coinpaprika.com API in Go. Coinpaprika delivers full market data to the wo

17 Dec 8, 2022

Golang client for ethereum json rpc api

Ethrpc Golang client for ethereum JSON RPC API. web3_clientVersion web3_sha3 net_version net_peerCount net_listening eth_protocolVersion eth_syncing e

247 Jan 7, 2023

Package githubv4 is a client library for accessing GitHub GraphQL API v4 (https://developer.github.com/v4/).

githubv4 Package githubv4 is a client library for accessing GitHub GraphQL API v4 (https://docs.github.com/en/graphql). If you're looking for a client

956 Dec 26, 2022

📟 Tiny utility Go client for HackerNews API.

go-hacknews Tiny utility Go client for HackerNews API. Official Hackernews API Install go get github.com/PaulRosset/go-hacknews Usage Few examples a

16 Sep 27, 2022

A golang client for the Twitch v3 API - public APIs only (for now)

go-twitch Test CLIENT_ID="my client ID" go test -v -cover Usage Example File: package main import ( "log" "os" "github.com/knspriggs/go-twi

22 Sep 27, 2022

Comments

add: .gitignore, cli w/ manpage & makefile

Just adds a command line interface to the library. Not sure if makefile should go in home or not. Should just need to add /cli to projdir variable in makefile if so.

Man pages are only supported for linux and darwin systems right now

Here's the main part of the readme:

Usage

xkcd [mode] [params]

modes:

config
fetch
likes
random
help

Examples

xkcd help [mode]  # info on a given mode
xkcd next  # fetch the comic whose index is one before the last one you saw
xkcd prev  # fetch the comic whose index is one greater than the last comic you saw
xkcd fetch -f  # fetch the latest comic even if you checked for it in the past 24 hours
xkcd random  # fetch a random
xkcd random -max 22  # fetch a random comic whose index is smaller than 22
xkcd likes 12  # add comic number 12 to your likes

Install

git clone https://github.com/nishanths/go-xkcd
cd go-xkcd/cli
make

opened by kendfss 1

Tests shouldn't perform live HTTP requests

Performing live HTTP requests means we are dependent on external resources such as a working network connection, the xkcd.com API not being down, etc.

But there is an advantage to doing live HTTP requests: it's quicker to be aware of breaking changes against the real API

opened by nishanths 1