Content Abstraction API

This application facilitates the demonstration of the use of Markov Chains theory by creating a proxy api that requires no authentication to fetch Tweets and moderate content.

Requirements and dependencies

• Python3 - We recommend using virtual environments. They will help on the creation of isolated environments so different python versions can run on the same machine. Check more about virtual environments here. (Needs to be installed manually)
• Pip - The python package manager. (Needs to be installed manually)
• Flask - A simple and flexible Python Web Framework that provides with tools, libraries and technologies to build a web application. (Installed by pip)
• Tweepy - Twitter for Python! (Installed by pip)
• dotenv - Get and set values in your .env file in local and production servers. (Installed by pip)
• Microsoft Content Moderator - Machine-assisted content moderation APIs and human review tool for images, text, and videos

Clone the project

Use the command below:

git clone https://github.com/MLH/localhost-python-abstraction.git

Set Up Environment variables

To quickly set up environment variables, make a copy of the .env.example and rename it to .env. Then make sure to modify it following the instructions below.

Microsoft Content Moderator API Keys

We need an API key to use this content moderator. Just click on get started and create your free account here. You will then have access to a key that you can use in the variable:

OCP_APIM_SUBSCRIPTION_KEY=

Twitter API Keys

We need to setup the twitter API keys to be able to fetch data from Twitter's API. Follow this guide to get your keys.

After going through the tutorial, you should have the following information:

CONSUMER_KEY= 
CONSUMER_SECRET= 
ACCESS_TOKEN=
ACCESS_TOKEN_SECRET=

You can also tweak NUM_TWEETS_TO_GRAB to get more or less data to feed the markov chain.

Create you virtual environment

Follow this guide: https://packaging.python.org/guides/installing-using-pip-and-virtualenv/ to create and activate an isolated virtual environment.

Install dependencies

The next step is to install the dependencies used by the project. Run the following command:

pip install -r requirements.txt

Executing the application

After having all the dependencies installed, you only need to execute the main application file. In this case it will be the file "main.py"

FLASK_APP=main.py FLASK_DEBUG=1 flask run

Then open http://localhost:5001/api/tweets/jimmyfallon to test the api.