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 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) ForEach(fn func(i int, tag *model.Tag))
  • func (r *Result) Len() int
  • func (r *Result) TagsStrings() []string

Variables

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

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

	// Content sets content of the target.
	Content = func(v string) Option {
		return func(c *config) {
			c.content = v
		}
	}

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

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

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

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

	// ContentOnly ignores all none content related parts of the HTML page.
	ContentOnly = func(v bool) Option {
		return func(c *config) {
			c.contentOnly = v
		}
	}

	// FullSite tells parser to process full site (HTML only).
	FullSite = func(v bool) Option {
		return func(c *config) {
			c.fullSite = v
		}
	}

	// TagWeights string with the custom tag weights for the HTML & Markdown tagging.
	TagWeights = func(v string) Option {
		return func(c *config) {
			c.tagWeights = v
		}
	}

	// TagWeightsJSON JSON file with the custom tag weights for the HTML & Markdown tagging.
	TagWeightsJSON = func(v string) Option {
		return func(c *config) {
			c.tagWeightsJSON = v
		}
	}

	AdjustScores = func(v bool) Option {
		return func(c *config) {
			c.adjustScores = v
		}
	}
)

Functions

func ToStrings

func ToStrings(items []*model.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
	Markdown
)

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
	DocHash     string
}

Meta extra information.

type Option

type Option func(*config)

Option allows to customise configuration.

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.