utils

package

v0.1.0 Latest Latest Go to latest Published: Jan 24, 2019 License: MIT Imports: 14 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Metadata struct {
	Type     string
	Template string
}

Metadata describes the configuration of a story

type Story struct {
	Meta Metadata
	Data map[string]interface{}
	// contains filtered or unexported fields
}

Story is metadata plus a set of variable chunks

func NewStoryFromFile(filePath string) (Story, error)

NewStoryFromFile loads a new Story generator from a config file

func NewStoryFromPath(path string) (Story, error)

NewStoryFromPath loads a new story generator from a file or URL

func NewStoryFromText(text []byte) (Story, error)

NewStoryFromText loads a new Story generator from a string

func NewStoryFromURL(url string) (Story, error)

NewStoryFromURL loads a new Story generator from a URL to a config file

func (s *Story) Generate() (string, error)

Generate creates a story string

func (s *Story) Init() error

Init sets up initial state for the Story object

func (s *Story) Upload(bucket, prefix string) (*Story, error)

Upload copies a story into S3