Skip to content

Commit 1bf1fe6

Browse files
committed
Add README.md and run.py
1 parent 5247066 commit 1bf1fe6

File tree

4 files changed

+38
-0
lines changed

4 files changed

+38
-0
lines changed

README.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Emojibot
2+
3+
Emojibot can predict how the user feels, and responds with a relevant Emoji.
4+
5+
![Emojibot prediciting the emotion of the user](resources/predicting-emotion.png)
6+
7+
You can also tell Emojibot your favourite Emoji and he'll remember it for later!
8+
9+
![Emojibot prediciting the emotion of the user](resources/setting-favourite.png)
10+
11+
Most of the heavy lifting is done by [DeepMoji](https://github.com/bfelbo/DeepMoji) and an [intent matcher](https://github.com/JCGrant/emojibot/blob/master/app/matcher.py).
12+
13+
The only endpoint the server exposes is a GET handler to "/transform?s=some sentence".
14+
15+
## Running
16+
17+
This code depends on Python2, mostly because that's what DeepMoji uses.
18+
19+
git clone [email protected]:JCGrant/emojibot.git
20+
cd emojibot
21+
pip install -r requirements.txt
22+
pushd client
23+
npm run build
24+
popd
25+
26+
FLASK_APP=app flask run
27+
28+
Or, if you don't have Python binaries in your PATH:
29+
30+
python run.py
31+
32+
## Testing
33+
34+
pytest tests.py -v

resources/predicting-emotion.png

408 KB
Loading

resources/setting-favourite.png

165 KB
Loading

run.py

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
from app import app
2+
3+
if __name__ == '__main__':
4+
app.run(debug=False, host='0.0.0.0')

0 commit comments

Comments
 (0)