Skip to content

Commit

Permalink
Updated README.
Browse files Browse the repository at this point in the history
  • Loading branch information
brizandrew committed Feb 21, 2018
1 parent 8cc4f14 commit 86081fc
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,18 @@
# Is This True Bot
A simple bot that responds to Tweets with potential fact checks.
This is simple bot that responds to Tweets with potential fact checks. A person must reply to a Tweet with a link, tagging [@IsThisTrueBot](www.twitter.com/IsThisTrueBot). Once they do, the bot will reply with a matching fact-check (if one exists) or an error if no link was found.

This bot is still in the early stages of development. Currently, it only searches PolitiFact for fact-checks. We plan to expand the evaluation to pull in different sources, including Snopes and other sites which support [`ClaimReview`](http://pending.webschemas.org/ClaimReview). The longer-term goal is to use machine learning to enhance our evaluation of sources.

If you tag a response and the bot is correct, please favorite the Tweet so we can begin to gather data on what is working well and what isn't as we dive into machine learning. Your feedback will help us improve this in the weeks to come.

## How Does This Work?

This script grabs the Tweet the tagged reply was in response to and gets the URL of the article linked within it. From there, it takes the headline, searches it on PolitiFact and gets the search results on the first page.

After that, it parses the words and weighs them according to headline, body text and the sources referenced in the article to find the best match to the link on Twitter. It assigns a score to all of the matches, and if the article meets a minimum confidence level, it will reply to your Tweet with the link.

## Installing a Development Copy
These instructions are mostly for us, but feel free to download a copy to play around with.

Create a virtualenv to store the codebase.
```bash
Expand Down

0 comments on commit 86081fc

Please sign in to comment.