Socket
Socket
Sign inDemoInstall

github.com/brittonhayes/dnd

Package Overview
Dependencies
14
Alerts
File Explorer

Install Socket

Detect and block malicious and high-risk dependencies

Install

    github.com/brittonhayes/dnd

package dnd is a Go Client for the DnD 5e REST API Install with the go get command View the full docs on pkg.go.dev https://pkg.go.dev/github.com/brittonhayes/dnd View the API here https://www.dnd5eapi.co/ Using the package is as easy as create client, pick the endpoint, and run the method. This applies across every data type so it is consistent across the board. Here's a simple _example of how to fetch a rule from the DnD 5e ruleset. Social image by Ashley Mcnamara https://twitter.com/ashleymcnamara 💖 If you'd like to contribute to DnD, make sure you've got mage installed: https://magefile.org


Version published

Readme

Source

DnD

Go Reference GitHub tag (latest SemVer) Go Report Card Test codecov

A Go Client for the Dungeons and Dragons 5e SRD REST API

Installation

Install with the go get command

go get github.com/brittonhayes/dnd

Documentation

View the full docs on pkg.go.dev

View the API here https://www.dnd5eapi.co/

Usage

Using the package is as easy as create client, pick the endpoint, and run the method. This applies across every data type, so it is consistent across the board. Here's a simple example of how to fetch a rule from the DnD 5e ruleset.

func main() {
    // Create a dnd client
    c := dnd.NewClient()
    
    // Fetch DnD rules about adventuring
    r, _ := c.Rules.Find("adventuring")
    
    // Print out the rule's name
    fmt.Println("Name", r.Name)
}

Examples

For example uses of the package, check out the example directory

Development

If you'd like to contribute to DnD, make sure you have mage installed: https://magefile.org

# Download dependencies and run tests
go run main.go download
go test ./...

Social image by Ashley Mcnamara https://twitter.com/ashleymcnamara 💖

FAQs

Last updated on 16 Feb 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc