wfwiki

module
v0.3.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 31, 2020 License: MIT

README

Warframe Wiki Module Query

Go Report Card

Summary

wfwiki is a go library for retrieving Warframe Fandom Wiki module as structs

Details

wfwiki is heavily inspired by Snekw's work

Behind the scenes, wfwiki uses a rate limited http request (1 tick per second) to call the Fandom Wiki's API. The JSON is then parsed through an embeded lua VM to generate a JSON string for the data table, and unmarshall's this into a struct.

Current tables which are supported:

  • Weapons
  • Warframes
  • Modules

TODO

  • Improve testing and test coverage
  • Implement CICD on Tekton
  • Support for data tables which have name collisions in the same object. Currently duplicate names like SecondaryAttack for a weapon will get dropped
  • Implement simple cache with checking of hash
  • Implement lua worker pool
  • Move GetStats outside of package. Currently it is used for a temporary test client
  • Create examples folder

Example

package main
import "github.com/obowersa/wfwiki/pkg/wfwiki"

func main (){
	wf := wfwiki.NewWFWiki()
	wf.GetStats("warframe","Ash")
}

Directories

Path Synopsis
cmd
internal
cli
lua
mwmod
Package mwmod converts the response from a mediawiki API request for a Module/data page and returns a json string with the pages content.
Package mwmod converts the response from a mediawiki API request for a Module/data page and returns a json string with the pages content.
ratelimit
Package ratelimit is a simple rate limiting implementation which works on an endpoint interface.
Package ratelimit is a simple rate limiting implementation which works on an endpoint interface.
pkg
wfwiki
Package wfwiki provides a client for the Warframe Fandom Wiki's module data.
Package wfwiki provides a client for the Warframe Fandom Wiki's module data.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL