tagify

package module
v0.58.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 2, 2022 License: Apache-2.0 Imports: 11 Imported by: 0

README

Tagify

Go Report Card Coverage GoDoc Mentioned in Awesome Go

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:

ZoomIO Tagify

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.

Extensions

There is support extensions. See extension/extension.go and its usages and implementations in processor/html/extension.go. For examples you can have a look at processor/html/extension_test.go.

Installation

Binary

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

For MacOS:

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

For MacOS (arm64):

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

For Linux:

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

For Windows:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/zoomio/tagify/master/_bin/install.sh)" -o 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

Constants

This section is empty.

Variables

View Source
var (
	Source = config.Source

	// headless
	Query      = config.Query
	WaitFor    = config.WaitFor
	WaitUntil  = config.WaitUntil
	Screenshot = config.Screenshot

	Content = config.Content

	// misc
	TargetType  = config.TargetType
	Limit       = config.Limit
	Verbose     = config.Verbose
	NoStopWords = config.NoStopWords
	StopWords   = config.StopWords
	ContentOnly = config.ContentOnly
	FullSite    = config.FullSite

	// weighing
	TagWeightsString      = config.TagWeightsString
	TagWeightsJSON        = config.TagWeightsJSON
	ExtraTagWeightsString = config.ExtraTagWeightsString
	ExtraTagWeightsJSON   = config.ExtraTagWeightsJSON
	ExcludeTagsString     = config.ExcludeTagsString
	AllTagWeights         = config.AllTagWeights
	AdjustScores          = config.AdjustScores

	Extensions = config.Extensions

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

	ContentTypeOf = config.ContentTypeOf
)

Functions

func Run added in v0.18.0

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

Run produces slice of tags ordered by frequency.

Types

type Config added in v0.49.1

type Config = config.Config

backwards compatibility

type ContentType added in v0.2.0

type ContentType = config.ContentType

type Option added in v0.18.0

type Option = config.Option

Directories

Path Synopsis
cmd
cli
md

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL