tagify

README

Tagify

Visit playground here:

Gets STDIN, file or HTTP address as an input and returns ordered list of most frequent words as an output. Does not support Single Page Apps (browser rendered) at the moment - Work-in-Progress.

Example, get 10 most frequent words from StackOverflow main page:

$ tagify -s=https://github.com/zoomio/tagify -l=3
frequent address apache

In code (see cmd/cli/cli.go).

Use -no-stop flag to disable stop-words filtering (github.com/zoomio/stopwords).

Installation

Binary

• download latest release for corrseponding OS (Darwin or Linux) from Releases
• make binary executable: chmod +x <binary>
• put executable binary under your bin directory, e.g. (assuming ~/bin is in your PATH): mv <binary> $HOME/bin/<binary>.

Go dependency

go get -u github.com/zoomio/tagify/...

Changelog

See CHANGELOG.md

Contributing

See CONTRIBUTING.md

License

Released under the Apache License 2.0.

Documentation

Index

• func GetTags(source string, contentType ContentType, limit int, verbose, noStopWords bool) ([]*processor.Tag, error)
• func GetTagsFromString(input string, contentType ContentType, limit int, verbose, noStopWords bool) ([]*processor.Tag, error)
• func ToStrings(items []*processor.Tag) []string
• type ContentType
  • func ContentTypeOf(contentType string) ContentType
  • func (contentType ContentType) String() string
• type In
  • func NewIn(name string) (In, error)
  • func NewInFromString(input string, contentType ContentType) In
  • func (in *In) ReadAllLines() ([]string, error)
  • func (in *In) ReadAllStrings() ([]string, error)

Functions

func GetTags

func GetTags(source string, contentType ContentType, limit int, verbose, noStopWords bool) ([]*processor.Tag, error)

GetTags produces slice of tags ordered by frequency and limited by limit.

func GetTagsFromString

func GetTagsFromString(input string, contentType ContentType, limit int, verbose, noStopWords bool) ([]*processor.Tag, error)

GetTagsFromString produces slice of tags ordered by frequency and limited by limit.

func ToStrings

func ToStrings(items []*processor.Tag) []string

ToStrings transforms a list of tags into a list of strings.

Types

type ContentType

type ContentType int

ContentType ...

const (
	Unknown ContentType = iota
	Text
	HTML
)

Content types

func ContentTypeOf

func ContentTypeOf(contentType string) ContentType

ContentTypeOf returns ContentType based on string value.

func (ContentType) String

func (contentType ContentType) String() string

String ...

type In

type In struct {
	ContentType
	// contains filtered or unexported fields
}

In - Input. This struct provides methods for reading strings and numbers from standard input, file input, URLs, and sockets.

func NewIn

func NewIn(name string) (In, error)

NewIn initializes an input stream from STDIN, file or web page.

name - the filename or web page name, reads from STDIN if name is empty. Panics on errors.

func NewInFromString

func NewInFromString(input string, contentType ContentType) In

NewInFromString ...

func (*In) ReadAllLines

func (in *In) ReadAllLines() ([]string, error)

ReadAllLines provides slice of lines from input.

func (*In) ReadAllStrings

func (in *In) ReadAllStrings() ([]string, error)

ReadAllStrings provides slice of strings from input split by white space.