tagify

README

Tagify

Tagify can recieve STDIN, file or HTTP address as an input and return a list of most popular words ordered by popularity as an output.

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

Supported formats:

• Plain text
• HTML
• Markdown

Supported languages:

• English
• Russian
• Chinese
• Hindi
• Hebrew
• Spanish
• Arabic
• Japanese
• German
• French
• Korean

Visit Tagify playground here:

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

$ tagify -s=https://github.com/zoomio/tagify -l=5
source html plain supports tags

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

Use -no-stop flag to disable filtering out of the stop-words.

Installation

Binary

Get the latest release of the Tagify by running this command in your shell:

For MacOS:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/zoomio/tagify/master/_bin/install.sh)" darwin

For Linux:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/zoomio/tagify/master/_bin/install.sh)" linux

For Windows:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/zoomio/tagify/master/_bin/install.sh)" windows

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 ToStrings(items []*model.Tag) []string
• type Config
• type ContentType
• type Meta
• type Option
• type Result
  • func Run(ctx context.Context, options ...Option) (*Result, error)
  • func (r *Result) ForEach(fn func(i int, tag *model.Tag))
  • func (r *Result) Len() int
  • func (r *Result) TagsStrings() []string

Variables

var (
	Source         = config.Source
	Query          = config.Query
	Content        = config.Content
	TargetType     = config.TargetType
	Limit          = config.Limit
	Verbose        = config.Verbose
	NoStopWords    = config.NoStopWords
	ContentOnly    = config.ContentOnly
	FullSite       = config.FullSite
	TagWeights     = config.TagWeights
	TagWeightsJSON = config.TagWeightsJSON
	AdjustScores   = config.AdjustScores

	Unknown  = config.Unknown
	Text     = config.Text
	HTML     = config.HTML
	Markdown = config.Markdown

	ContentTypeOf = config.ContentTypeOf
)

Functions

func ToStrings

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

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

Types

type Config

type Config = config.Config

backwards compatibility

type ContentType

type ContentType = config.ContentType

type Meta

type Meta struct {
	ContentType ContentType
	DocTitle    string
	DocHash     string
}

Meta extra information.

type Option

type Option = config.Option

type Result

type Result struct {
	Meta *Meta
	Tags []*model.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) ForEach

func (r *Result) ForEach(fn func(i int, tag *model.Tag))

ForEach iterates through the slice of Tags and calls provided "fn" on every iteration.

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.