https://github.com/chshersh/sauron

👁‍🗨 The eye that watches everything you did on Twitter
https://github.com/chshersh/sauron

haskell twitter

Last synced: 10 months ago
JSON representation

👁‍🗨 The eye that watches everything you did on Twitter

• Host: GitHub
• URL: https://github.com/chshersh/sauron
• Owner: chshersh
• License: mpl-2.0
• Created: 2022-08-31T15:54:04.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-01-11T12:17:05.000Z (about 3 years ago)
• Last Synced: 2025-03-21T01:34:02.961Z (11 months ago)
• Topics: haskell, twitter
• Language: Haskell
• Homepage:
• Size: 77.1 KB
• Stars: 23
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# sauron

[![GitHub CI](https://github.com/chshersh/sauron/workflows/CI/badge.svg)](https://github.com/chshersh/sauron/actions)

[![Hackage](https://img.shields.io/hackage/v/sauron.svg?logo=haskell)](https://hackage.haskell.org/package/sauron)

[![MPL-2.0 license](https://img.shields.io/badge/license-MPL--2.0-blue.svg)](LICENSE)

👁 `sauron` is a CLI tool that fetches info from Twitter and analyses it.

> 🌈 `sauron` is a demo project implemented using [Iris][iris] — a Haskell CLI

> framework.

[iris]: https://github.com/chshersh/iris

## Features

Features currently supported by `sauron`:

* Get top tweets of a Twitter account (limited by only 3200 recent tweets)

* Save intermediate results to a file (to avoid hitting Twitter API limit too early)

* Read cached results from a file

## How to use?

1. [Generate your own Twitter token][token] and export it as the

   `$TWITTER_TOKEN` variable.

2. Clone the project.

    ```shell

    git clone git@github.com:chshersh/sauron.git

    cd sauron

    ```

3. Build and run the tool

    

    > ⚠️ Requires GHC 9.2

    ```shell

    cabal run sauron -- top @ --max=20 --to-file=path/to/save/results.json

    ```

[token]: https://developer.twitter.com/en/docs/twitter-api/getting-started/getting-access-to-the-twitter-api