https://github.com/xdevplatform/live-leaderboard

This Flask app listens for incoming scores via Twitter Direct Messages, ranks them, and Tweets the rankings.
https://github.com/xdevplatform/live-leaderboard

account-activity-api chatbots python twitter twitter-api webhook

Last synced: about 20 hours ago
JSON representation

This Flask app listens for incoming scores via Twitter Direct Messages, ranks them, and Tweets the rankings.

• Host: GitHub
• URL: https://github.com/xdevplatform/live-leaderboard
• Owner: xdevplatform
• License: mit
• Created: 2019-09-11T22:36:54.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2022-12-08T07:29:50.000Z (almost 2 years ago)
• Last Synced: 2024-04-22T01:00:33.130Z (7 months ago)
• Topics: account-activity-api, chatbots, python, twitter, twitter-api, webhook
• Language: Python
• Homepage:
• Size: 188 KB
• Stars: 9
• Watchers: 14
• Forks: 6
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Live Leaderboard

![Twitter Premium API v1.1](https://img.shields.io/endpoint?url=https%3A%2F%2Ftwbadges.glitch.me%2Fbadges%2Fpremium)

![Twitter Enterprise API](https://img.shields.io/endpoint?url=https%3A%2F%2Ftwbadges.glitch.me%2Fbadges%2Fenterprise)

Using the Account Activity, Direct Message, and Post Tweet APIs, this Twitter chatbot listens for incoming scores, ranks them, and Tweets the rankings. This app supports public 'leaderboard' announcements and private data/vote submissions.

This example was written to keep golf scores, but the underlying patterns are general enough to serve many other use cases. Other events come to mind, such as soccer and bowling tournaments. Scavenger hunts are a good use case match, where updates are sent in from the field. Since this protoype is based on scores/votes being privately submitted, these patterns are the building blocks for supporting any election event.

**What does the bot do?**

+ Keeps track of all teams scores in real-time on Twitter

+ Tweets out updates (Leaderboards and Birdie Alerts!)

+ Foster engagement and get people talking about the event and interacting with the scorer account.

**To learn more about the event this pilot was developed for, see the following:**

+ The use case inspiration for this code base is [on our blog](https://blog.twitter.com/en_us/topics/insights/2020/building-a-real-time-golf-leaderboard)

+ For more discussion of the code developed for this pilot, see [our tutorial](https://dev.to/twitterdev/building-a-live-leaderboard-on-twitter-49g9)

## Getting started

So, here is what you'll need to get started:

+ Python 3 environment with the Flask web framework.

+ Somewhere to host the app. For this project we used Heroku.

+ Twitter details:

  + Twitter API Essential Access ([sign up here](https://developer.twitter.com/en/portal/petition/essential/basic-info))

    + Create a Twitter App if you don't already have one.

    + Consumer API keys for your app.

    + Get to know the [Account Activity API](https://developer.twitter.com/en/docs/twitter-api/enterprise/account-activity-api/guides/getting-started-with-webhooks)

    + Have a Twitter account to host the scorer app, and register that account with the AAA. For this prototype we used the [@HackerScorer](https://twitter.com/HackerScorer) account.

## Configuration details

The app will first try to read from a `.env` file using `python-dotenv` package, but can use environment variables if no .env file is found. Below are the config details captured by the .env file.

```python

HOST_ACCOUNT_ID = os.getenv('HOST_ACCOUNT_ID', None)  #OR os.environ.get

CONSUMER_KEY = os.getenv('CONSUMER_KEY', None)

CONSUMER_SECRET = os.getenv('CONSUMER_SECRET', None) #Also needed for CRC.

ACCESS_TOKEN = os.getenv('ACCESS_TOKEN', None)

ACCESS_TOKEN_SECRET = os.getenv('ACCESS_TOKEN_SECRET', None)

DATABASE = os.getenv('DATABASE', None)

DATABASE_HOST = os.getenv('DATABASE_HOST', None)

DATABASE_USER = os.getenv('DATABASE_USER', None)

DATABASE_PASSWORD = os.getenv('DATABASE_PASSWORD', None)

```

The par scores for a given course must be set in the main app file (see below).

```python

# TODO: --> config.dat

PARS = [5, 4, 3, 4, 3, 5, 4, 4, 4, 4, 4, 3, 4, 4, 5, 5, 3, 4]

```

## Helper scripts

The `/scripts` folder contains simple helper scripts for interacting with the Account Activity API. If you choose the free tier of AAAPI access, you may find yourself deleting and registering webhooks frequently as you move from local testing (ngrok) to your deployed app (Heroku).

The scripts load for OAuth 1.0 details from a `.env` file, using `python-dotenv` package, and make http calls using the `requests` library.

1. Register a webhook: `python register_webhook.py` (specify env name if using premium)

2. Subscribe app to own activity (@handle tied to app): `python subscribe_owning_user.py`

3. Get webhook info: `python get_webhooks.py`

4. Delete webhook registration: `python delete_webhook.py` (prompts for webhook_id as input)

## Using the Twitter chatbot

### Becoming a scorer

Follow the account of the event scorer. Learn how to submit scores, make updates, and be familiar with the FAQ section below.

### Submitting a score

At the end of every hole, send the scorer account (e.g. @HackerScorer) a Direct Message (DM) with your team number, the hole you just completed, and the number of strokes needed to complete the hole. Say you are team 6, you just completed hole 12 in four strokes. This information should be formatted exactly like this: ```t6 h12 s4```

**Where:**

+ *t# = Your team number.* This doesn't change. Your team number is indicated by the hole you started on. Team 6 started on hole 6.

+ *h# = Hole number you are reporting a score for*

+ *s# = Your score. The number of strokes.*

### Correcting a score

Mistakes happen. Typing with gloves on is problematic. So, what happens when an incorrect score is submitted? Well, you just send an ```update``` DM with the correct scoring. That's it.

For example, you are on team 17 and your team got a birdie on the seventh hole, a 5-par hole. The team scorer incorrectly submitted a ```t17 h7 s5``` score. To correct this, the following DM is sent: ```update t17 h7 s4```.

## FAQ

**What if I forget to DM the bot after playing a hole?**

That's ok! Just send a DM for any hole you forgot to submit.

**What if I enter my score wrong?**

Try not to. Enter your team number, hole, and score very carefully. If you mess up, send an 'update' DM. For example, if you DM'ed ```t6 h4 s5``` but the correct score was ```4```, DM ```update t6 h4 s4```.

**How do I know if I did it right?**

A correctly formatted score receives a confirmation DM (currently 'Thanks, we got it!"), and if that is not received, then the score was not accepted.

**I'm on a team of four, do we all have to do this?**

No. Designate one team mate to do this after each hole. Try to remind your team mate to do this!

**Should we remove par (over/under)?**

Submit the TOTAL number of strokes that your team took. Do NOT subtract par. For example, if your team hit 5 times on a par 3, your score is 5. NOT 2.

**Does our team still have to keep score with the paper scorecard?**

YES! This is your final scorecard for determining the winning team at the end. This bot is an experiment and for fun.

### Some saved code used for unit testing

```python

#Some code used for for unit testing.

if __name__ == '__main__':

   #Seeding database with data.

   handle_score("t1 h1 s4")

   handle_score("t1 h2 s5")

   handle_score("t1 h3 s4")

   #Randomizing an entire tournament.

   for h in range(18):

      hole = h + 1

      for t in range(18):

         team = t + 1

          score = random.randrange(PARS[int(hole-1)]-1, PARS[int(hole-1)]+4, 1)

          handle_score(f"t{team} h{hole} s{score}")

          time.sleep(2)

   create_standings()

```