Git Product home page Git Product logo

tweetdigest's Introduction

tweetdigest

GitHub release MIT License Go Report Card PRs Welcome

Compile tweets into a email digest

tweetdigest uses the Twitter API to compile tweets from users into a email digest. This digest is intended to be run for specific intervals such as daily.

Install

This application requires API keys from Twitter (both the consumer API keys and access token). These can be acquired by creating an application from the Twitter developer portal at https://developer.twitter.com/. Once you have your keys, create a copy of config.sample.yml and modify with your values.

Option 1: Binary

Download the latest release from https://github.com/jakewarren/tweetdigest/releases/latest

Option 2: From source

go install github.com/jakewarren/tweetdigest@latest

Usage

❯ tweetdigest -h
Description: compiles tweets into an email digest

Usage: tweetdigest -d [duration] [twitter username]

Options:
  -c, --config string       filepath to the config file
  -d, --duration duration   how far back to include tweets in the digest (example: "-24h") (default -24h0m0s)
  -t, --email-to strings    email address(es) to send the report to
      --include-replies     include replies in the digest (default true)
      --include-retweets    include retweets in the digest (default true)
      --tweet-count int     number of tweets to analyze (max 200) (default 50)
  -v, --verbose             enable verbose output
  -V, --version             show version information

Example:

tweetdigest --duration "-24h" -c ~/.tweetdigest.yml SwiftOnSecurity

Demo

Screenshot of the sample digest:

Changes

All notable changes to this project will be documented in the changelog.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

License

MIT © 2019 Jake Warren

tweetdigest's People

Contributors

dependabot-preview[bot] avatar dependabot[bot] avatar jakewarren avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.