tagify

README

Tagify

Gets STDIN, file or HTTP address as an input and returns a list of most popular words ordered by popularity as an output. Currently only supports plain text and HTML.

More info about what is "Tagify" and the reasons behind it can be found here.

Visit playground here:

Example, "tagify" this repository (with the limit of 3 tags):

$ tagify -s=https://github.com/zoomio/tagify -l=3
github code tag

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

• Variables
• func GetTagsFromString(input string, contentType ContentType, limit int, verbose, noStopWords bool) ([]*processor.Tag, []byte)
• func ToStrings(items []*processor.Tag) []string
• type ContentType
  • func ContentTypeOf(contentType string) ContentType
  • func (ct ContentType) String() string
• type Meta
• type Option
• type Result
  • func Run(ctx context.Context, options ...Option) (*Result, error)
  • func (r *Result) Len() int
  • func (r *Result) TagsStrings() []string

Variables

var (
	// Source sets target source.
	Source = func(source string) Option {
		return func(c *config) {
			c.source = source
		}
	}

	// Query sets CSS query for the target.
	Query = func(query string) Option {
		return func(c *config) {
			c.query = query
		}
	}

	// TargetType sets content type of the target.
	TargetType = func(contentType ContentType) Option {
		return func(c *config) {
			c.contentType = contentType
		}
	}

	// Limit sets cthe limit of tags for the target.
	Limit = func(limit int) Option {
		return func(c *config) {
			c.limit = limit
		}
	}

	// Verbose enables high verbosity.
	Verbose = func(verbose bool) Option {
		return func(c *config) {
			c.verbose = verbose
		}
	}

	// NoStopWords enables stop-words exclusion from the output.
	NoStopWords = func(noStopWords bool) Option {
		return func(c *config) {
			c.noStopWords = noStopWords
		}
	}
)

Functions

func GetTagsFromString

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

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 byte

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 (ct ContentType) String() string

String ...

type Meta

type Meta struct {
	ContentType ContentType
	DocTitle    string
	DocVersion  string
}

Meta extra information.

type Option

type Option func(*config)

Option allows to customise configuration.

type Result

type Result struct {
	Meta *Meta
	Tags []*processor.Tag
}

Result represents result of Tagify.

func Run

func Run(ctx context.Context, options ...Option) (*Result, error)

Run produces slice of tags ordered by frequency.

func (*Result) Len

func (r *Result) Len() int

Len returns count of tags in the result.

func (*Result) TagsStrings

func (r *Result) TagsStrings() []string

TagsStrings transforms slice of tags into a slice of strings.