https://github.com/umputun/rss2twitter

publish rss updates to twitter
https://github.com/umputun/rss2twitter

automation rss twitter

Last synced: about 2 months ago
JSON representation

publish rss updates to twitter

• Host: GitHub
• URL: https://github.com/umputun/rss2twitter
• Owner: umputun
• License: mit
• Created: 2018-12-05T02:31:25.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2022-03-01T01:51:15.000Z (almost 3 years ago)
• Last Synced: 2024-10-16T09:20:33.009Z (2 months ago)
• Topics: automation, rss, twitter
• Language: Go
• Homepage:
• Size: 1.85 MB
• Stars: 56
• Watchers: 6
• Forks: 12
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# rss2twitter [![Build Status](https://github.com/umputun/rss2twitter/workflows/build/badge.svg)](https://github.com/umputun/rss2twitter/actions) [![Coverage Status](https://coveralls.io/repos/github/umputun/rss2twitter/badge.svg?branch=master)](https://coveralls.io/github/umputun/rss2twitter?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/umputun/rss2twitter)](https://goreportcard.com/report/github.com/umputun/rss2twitter) [![Docker Automated build](https://img.shields.io/docker/automated/jrottenberg/ffmpeg.svg)](https://hub.docker.com/r/umputun/rss2twitter/)

The service publishes RSS updates to twitter. The reason is simple - I needed self-hosted thingy to post tweets on a feed change for my sites (podcasts and blogs). Tried several "cloud services" for this and lately switched to IFTTT. It worked, but slow and unreliable. Sometimes it took hours to get twit posted, sometimes I had to trigger it manually. In addition IFTTT can't have multiple twitter accounts defined for the same IFTTT account and I had to deal with multiple IFTTT accounts just to post to different twitter's timelines.

## Install

Use provided `docker-compose.yml` and change `FEED` value. All twitter-api credentials can be retrieved from https://developer.twitter.com/en/apps and should be set in environment or directly in the compose file.

## Templates

`--template` parameter (env `$TEMPLATE`) defines output tweet's format with:

- `{{.Title}}` - title fo rss item (entry) 

- `{{.Link}}` - rss link

- `{{.Text}}` - item description

_default is `{{.Title}} - {{.Link}}`_

  

## Parameters

```

Application Options:

  -r, --refresh=         refresh interval (default: 30s) [$REFRESH]

  -t, --timeout=         rss feed timeout (default: 5s) [$TIMEOUT]

  -f, --feed=            rss feed url [$FEED]

      --consumer-key=    twitter consumer key [$TWI_CONSUMER_KEY]

      --consumer-secret= twitter consumer secret [$TWI_CONSUMER_SECRET]

      --access-token=    twitter access token [$TWI_ACCESS_TOKEN]

      --access-secret=   twitter access secret [$TWI_ACCESS_SECRET]

      --template=        twitter message template (default: {{.Title}} - {{.Link}}) [$TEMPLATE]

      --dry              dry mode [$DRY]

      --dbg              debug mode [$DEBUG]

```

- refresh interval defines how often RSS feed will be checked and restricts the minimal time interval between two tweets. 

- values for `refresh` and `timeout` should be presented with units "d" (days), "h" (hours), "m" (minutes) os "s" (seconds)

- `dry` disables publishing to twitter and sends updates to logger only

## Exclusion Patterns

In the project root, there's a `exclusion-patterns.txt` file that you can use to exclude certain RSS feed messages from being sent to Twitter.

The `exclusion-patterns.txt` contains a list of [regular expressions](https://medium.com/factory-mind/regex-tutorial-a-simple-cheatsheet-by-examples-649dc1c3f285), one regex per line. Lines starting with # are ignored, and are treated as comments.

If the message from the RSS feed matches any of the regular expressions in the `exclusion-patterns.txt` file, it is not sent to Twitter.