contributter-ranking-bot 0.1.2

Contributter Ranking Bot

contributter-ranking-bot

• Contributter Ranking Bot for Twitter
• Forked from shuntatakemoto/contributter-ranking-bot

Deployment on Twitter

• Original:
  • → Forked:

Installation

pip install contributter-ranking-bot
# or:
pip install git+https://github.com/eggplants/contributter-ranking-bot

Tweet Format

✨Contribution Ranking - {YYYY/MM/DD}✨
{prefix} {num}🟩: @{mention_interrupt}{name}
...
{prefix} {num}🟩: @{mention_interrupt}{name}
📊<[ppl: {contrib_n}👤, sum: {contrib_sum}🟩, avg: {avg:.2f}🟩]
#contributter_ranking

CLI Usage

$ crb -h
usage: crb [-h] [-k PATH] [-d DAY] [-w SEC] [-n N] [-q] [-D] [-V]

This command makes Contributter Ranking Bot easier to run.

optional arguments:
  -h, --help                show this help message and exit
  -k PATH, --key PATH       key file (default: None)
  -d DAY, --day-before DAY  n days before (default: 1)
  -w SEC, --wait-sec SEC    interval of retrieving tweets (default: 10)
  -n N, --top-n N           top n to tweet (default: 3)
  -q, --quiet               suppress log print (default: False)
  -D, --dry-run             tweet without mentions (default: False)
  -V, --version             show program's version number and exit

$ cat .twitter.key
CONSUMER_KEY="***"
CONSUMER_SECRET="***"
ACCESS_TOKEN="***"
ACCESS_TOKEN_SECRET="***"

$ crb -k .twitter.key
# Running Bot was successful!
# See at: https://twitter.com/satoch_bot/status/1517223447868448768
{
    "created_at": "Thu Apr 21 19:27:13 +0000 2022",
...
}

# 5 days before, tweet top-five ranking
$ crb -d 5 -n 5 -k .twitter.key

License

MIT