piha

command module
v0.0.0-...-c3000f2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 22, 2020 License: Apache-2.0 Imports: 10 Imported by: 0

README

piha

CodeQL

A twitter bot that automatically tweets a rant.

What's with the name?

Named after the screaming bird piha, it represents the bot's action - ranting/screaming. 😜

Why is it built?

  1. I wanted to practice my recently acquired Golang skills.
  2. My internet service provider was extremely terrible at addressing requests. Tired of following up with them, I wrote this bot to do that for me repeatedly and automatically until my issues are resolved.
  3. We all need a twitter bot at some point in our life! 😉

How do I run it?

Prerequisite
  1. You will need a twitter developer account. Follow the instructions here to set up a new twitter bot app and gather the following secrets:
    • TWITTER_API_KEY
    • TWITTER_API_KEY_SECRET
    • TWITTER_ACCESS_TOKEN
    • TWITTER_ACCESS_TOKEN_SECRET
  2. edit config.env file and setup the below configurations
    • RANT_USER - the twitter handle of the service provider
    • RANT_DATE - the date in YYYY-MM-DD format when your issue with the service provider occurred
    • RANT_TEMPLATE - the rant tweet template. DO NOT change the text inside {{}} including the braces.
Run on GitHub

The project utilizes GitHub Actions to automatically run piha daily at 10 AM IST.

  1. Fork this repo
  2. Click on Settings tab and then on Secrets option
  3. Add each of the secrets gathered from prerequisite step 1
  4. Optionally edit .github\workflows\run-piha.yml and change on.cron.schedule property to run the tool at your desired time
  5. To stop piha, move run-piha.yml file out of the workflows directory
Run Locally
  1. Clone this repo
  2. run cp example.env local.env
  3. edit local.env file and set the secrets gathered from prerequisite step 1
  4. run go get -v -t -d ./... to install the dependencies
  5. run go run piha.go

Peace ✌

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL