deastiny/coffeerecommendationbot

Recommends a coffee to Twitterusers in need !

CoffeeRecommendationBot

Recommends a coffee to Twitterusers in need !

You can see a version of this bot running here. I'm still struggling with the automatic responses, but the daily coffee tweet is working great !

Features

• Responds to direct mentions
• Likes / Retweets indirect mentions
• Can tweet a "Coffee of the Day" style tweet
• Updates it's beverages from Starbucks (Thanks to @emorres25 !)
• Manages drinks in easy-to-edit JSON format (Thanks to @tsonnen !)
• Constant quality checks with Travis-CI (Thanks to @Twista !)
• Well maintained code, written with lot's of love (Thanks to everyone !)

Setup

Install the requirements with pip install -r requirements.txt

Create a keys.py file with the required tokens:

consumer_key=""
consumer_secret=""
access_token_key=""
access_token_secret=""

Testing

Travis CI

Configuration for Travis CI can be found inside .travis.yml. The demo version of this bot runs on Python 2.7.

If you want travis to use other Python versions like 3.3 you can simply change the python: line inside .travis.yml

.travis.yml Python 3.3 Sample

language: python

python:
  - 3.3

install:
  - pip install -r requirements.txt
  - pip install pep8 flake8
  - pip list

script:
  - flake8 .

You can even test for multiple Python environments (2.7 & 3.3 in the sample below):smile:

.travis.yml Python 2.7 & 3.3 Sample

language: python

python:
  - 2.7
  - 3.3

install:
  - pip install -r requirements.txt
  - pip install pep8 flake8
  - pip list

script:
  - flake8 .

Contribution Guidelines

Thanks for the interest ! Contributing guidelines are available in 'CONTRIBUTING.md'

License

This project is licensed under the terms of the MIT license. The full license text is available in the LICENSE file.

coffeerecommendationbot's Issues

Setup a script for automatic crontab / service configuration

Via crontab the bot should tweet the coffee of the day at a fixed time every day. In addition to that the bot should always be running to monitor it's timeline and respond to mentions.

Make code great again

Make the code PEP-8 compliant.
In #15 functions have already been documented and https://github.com/the-zebulan pointed out a bunch of PEP-8 issues.
These need to be fixed as well !

Move Contribution Guidelines to CONTRIBUTION.md

Just move the contents for an easy #hacktober

Tweet to random persons every once in a while

I'm not sure if this 100% compiles with Twitter's botting guidelines.
On spamming everyone that is available the bot got banned in a minute - it should be possible though to write messages to people talking about #coffee e.g. every once a day .
https://support.twitter.com/articles/490683

Add any of the following

Improve drink generation algorithm
SPAM MORE
Add more drinks
Provide customized drinks
Add some documentation
Clean up the mess

Updating documentation

add background and update the README.md, and seeing if I can contribute to the documentation updated in #15

Post a picture of the base coffee along with the main tweet

I just had this idea. What da' ya' say?

crawling

Merging scripts

It isn't really neccessary to have two different scripts, merging them would make this a bit more pythonistic ;)

Crawl currently available drinks from Starbucks

Not sure if this is even possible. Do they have a online list of drinks ?

Should Python 3.6 be in .travis.yml ?

Right now builds fail because of it - I removed it for now, but kinda have little idea of what I'm doing.

Providing customized drinks

Just a heads up, this is my first time contributing to a project, so please bear with me.

I'm looking at adding a feature to provide customized drink options! My thought process behind the implementation is creating a console menu with options to either send a randomly generated tweet or to customize one of the attributes of the drink itself.

From the second option, another menu would be displayed to choose which attribute to change. After selecting the attribute, the user would be able to enter in their own text, return to the customization menu and finally send the tweet. So they can customize as much, or as little, as they want.

As far as the implementation of the code, i'm looking at having the code flow like below.

main_menu()-->customize_order_menu()-->customize_attribute-->go back to customize_order_menu()-->make_tweet()-->send_tweet()

So the program will end up behaving a bit differently when I'm done. If anyone has any thoughts or suggestions, I'd love to hear them.

Creation of "popular" and "roasts" categories

I feel it would be a great idea to allow a twitter user to ask the CoffeeBot for a current popular coffee type.

"roasts" category was added as a certain type of hot coffee to order. Not sure what to do with this category though.

This could possibly be implemented by tweeting to a random follower a popular coffee every once in a while. What do you guys think?

Build failing on Python 3 Environments after PR#34

@DeastinY Please merge my incoming pull request before merging any other prs.

This issue fixes build failing after merging in pull request #34 which solves issue #16

Build for all Python 3 env fails as xrange has been replaced with range

My pr contains a dirty workaround to make builds pass (hopefully the workaround works)

Add different Python Versions to travis in Readme.md

Moving from urllib2 to requests

Hey @DeastinY
Kudos on making this bot.

While reading the code of the crawler "coffe_crawler.py", I find that we are using urllib2 for our HTTP connections. However, its API is a bit broken and too tedious at times. I would like to suggest that we move to Requests library. Here is a discussion on the three libraries: http://stackoverflow.com/questions/2018026/what-are-the-differences-between-the-urllib-urllib2-and-requests-module

Let me know what you think about this. I would be more than happy to make the changes.