Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gernest/mention
Twitter like mentions and #hashtags parser for Go(Golang)
https://github.com/gernest/mention
hashtag parser twitter
Last synced: 7 days ago
JSON representation
Twitter like mentions and #hashtags parser for Go(Golang)
- Host: GitHub
- URL: https://github.com/gernest/mention
- Owner: gernest
- License: mit
- Created: 2015-10-12T22:25:16.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2020-03-20T22:48:19.000Z (almost 5 years ago)
- Last Synced: 2024-12-06T13:43:18.588Z (20 days ago)
- Topics: hashtag, parser, twitter
- Language: Go
- Homepage:
- Size: 16.6 KB
- Stars: 107
- Watchers: 8
- Forks: 14
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# mention [](https://travis-ci.org/gernest/mention) [](https://coveralls.io/github/gernest/mention?branch=master) [](https://godoc.org/github.com/gernest/mention)
`mention` parses twitter like mentions and hashtags like @gernest and #Tanzania from text input.
# Installation
go get github.com/gernest/mention
# Usage
`mention` is flexible, meaning it is not only limited to `@` and `#` tags. You can choose whatever tag you like and mention will take it from there.
## twitter like mentions
For instance you have the following message
```
hello @gernesti I would like to follow you on twitter
```
And you want to know who was mentioned in the text.
```go
package main
import (
"fmt"
"strings"
"github.com/gernest/mention"
)
func main() {
message := "hello @gernest I would like to follow you on twitter"
tags := mention.GetTags('@', message)
tagStrings := mention.GetTagsAsUniqueStrings('@', message)
fmt.Println(tags)
fmt.Println(tagStrings)
}
```
If you run the above example it will print `[gernest]` is the stdout.
## twitter like hashtags
For instance you have the following message
```
how does it feel to be rejected? #loner
```
And you want to know the hashtags
```go
package main
import (
"fmt"
"strings"
"github.com/gernest/mention"
)
func main() {
message := "how does it feel to be rejected? #loner"
tags := mention.GetTags('#', message)
fmt.Println(tags)
}
```
If you run the above example it will print `[loner]` in the stdout.
# The API
mention exposes only one function `GetTags(char rune, src string) []string`
The first argument `char` is the prefix for your tag, this can be `@` or `#` or whatever unicode character you prefer. Don't be worried by its type `rune` it is just your normal characters but in single quotes. See the examples for more information.
The second argument is the source of the input which can be from texts.
# Contributing
Start with clicking the star button to make the author and his neighbors happy. Then fork the repository and submit a pull request for whatever change you want to be added to this project.
If you have any questions, just open an issue.
# Author
Geofrey Ernest
Twitter : [@gernesti](https://twitter.com/gernesti)
Chad Barraford
Github : [@cbarraford](https://github.com/cbarraford)
# Licence
This project is released under the MIT licence. See [LICENCE](LICENCE) for more details.