Sherlock

Small API to analyse text and retrieve people's information.

Requirements

• Python 3.6
• (Optional) Docker

How to use on UNIX/MAC

1. Clone this repo : git clone https://github.com/AxelDelsol/Sherlock.git
2. Move inside the repo : cd Sherlock
3. Install the dependencies : pip install -r requirements.txt
4. Set up the following environement variables:
   • export TEXTRAZOR_API_KEY="your_key"
   • export FLASK_APP="sherlock"
5. flask run

How to use on Windows

1. Clone this repo : git clone https://github.com/AxelDelsol/Sherlock.git
2. Move inside the repo : cd Sherlock
3. Install the dependencies : py -m pip install -r requirements.txt
4. Set up the following environment variables:
   • $env:TEXTRAZOR_API_KEY="your_key"
   • $env:FLASK_APP="sherlock"
5. flask run

Build a docker image

1. Clone this repo : git clone https://github.com/AxelDelsol/Sherlock.git
2. Move inside the repo : cd Sherlock
3. docker build --build-arg TextRazorKey="your_key" -t sherlock-demo .
4. docker run -p 5000:5000 sherlock-demo
5. Visit http://localhost:5000/ and have fun !