Cleanup from code review.

Author: Jeff Ammons

MANIFEST.in

@@ -1,3 +1,4 @@
 include LICENSE
 include CHANGELOG.md
-include README.md
+include README.md
+

README.md

@@ -6,7 +6,7 @@ python-rtmbot
 
 A Slack bot written in Python that connects via the RTM API.
 
-Python-rtmbot is a bot engine. The plugins architecture should be familiar to anyone with knowledge to the [Slack API](https://api.slack.com) and Python. The configuration file format is YAML.
+Python-rtmbot is a bot engine. The plugins architecture should be familiar to anyone with knowledge of the [Slack API](https://api.slack.com) and Python. The configuration file format is YAML.
 
 Some differences to webhooks:
 
@@ -28,21 +28,21 @@ Installation
         mkdir myproject
         cd myproject
 
-2. Install rtmbot (ideally into a virtualenv https://virtualenv.readthedocs.io/en/latest/)
+2. Install rtmbot (ideally into a [virtualenv](https://virtualenv.readthedocs.io/en/latest/))
 
         pip install rtmbot
 
-3. Create and rtmbot.conf file and configure rtmbot (https://api.slack.com/bot-users)
+3. Create an rtmbot.conf file and [create a bot for your team](https://api.slack.com/bot-users)
 
         # Add the following to rtmbot.conf
         DEBUG: True # make this False in production
         SLACK_TOKEN: "xoxb-11111111111-222222222222222"
         ACTIVE_PLUGINS:
             - plugins.repeat.RepeatPlugin
 
-```DEBUG``` will adjust logging verbosity and cause the runner to exit on exceptions, generally making dubugging more pleasant.
+```DEBUG``` will adjust logging verbosity and cause the runner to exit on exceptions, generally making debugging more pleasant.
 
-```SLACK_TOKEN``` is needed to authenticate with your Slack team. More info at https://api.slack.com/web#authentication
+```SLACK_TOKEN``` is needed to [authenticate with your Slack team.](https://api.slack.com/web#authentication)
 
 ```ACTIVE_PLUGINS``` RTMBot will attempt to import any Plugin specified in `ACTIVE_PLUGINS` (relative to your python path) and instantiate them as plugins. These specified classes should inherit from the core Plugin class.
 
@@ -63,7 +63,7 @@ RtmBot
 
 Add Plugins
 -------
-Plugins can live within any python module, but we recommend just putting them in ./plugins. (Don't forget to add an __init__.py file to your directory to make it a module -- use `touch __init__.py` within your plugin directory to create one)
+Plugins can live within any python module, but we recommend just putting them in ./plugins. (Don't forget to add an `__init__.py` file to your directory to make it a module -- use `touch __init__.py` within your plugin directory to create one)
 
 To add a plugin, create a file within your plugin directory (./plugins is a good place for it).
 

requirements.txt

@@ -1,5 +1,4 @@
 requests
-python-daemon
 pyyaml
 websocket-client
 slackclient

rtmbot/core.py

@@ -30,7 +30,8 @@ def __init__(self, config):
 
         # set slack token
         self.token = config.get('SLACK_TOKEN', None)
-        # TODO: Raise an exception if no SLACK_TOKEN is specified
+        if not self.token:
+            raise ValueError("Please add a SLACK_TOKEN to your config file.")
 
         # get list of directories to search for loading plugins
         self.active_plugins = config.get('ACTIVE_PLUGINS', [])
@@ -71,8 +72,12 @@ def _start(self):
             try:
                 self._dbg("Registering jobs for {}".format(plugin.name))
                 plugin.register_jobs()
-            except:
+            except NotImplementedError:  # this plugin doesn't register jobs
                 self._dbg("No jobs registered for {}".format(plugin.name))
+            except Exception as error:
+                self._dbg("Error registering jobs for {} - {}".format(
+                    plugin.name, error)
+                )
         while True:
             for reply in self.slack_client.rtm_read():
                 self.input(reply)
@@ -138,8 +143,10 @@ def load_plugins(self):
                 # otherwise we log the exception and carry on
                 try:
                     cls = import_string(plugin_path)
-                except ImportError:
-                    logging.exception("Problem importing {}".format(plugin_path))
+                except ImportError as error:
+                    logging.exception("Problem importing {} - {}".format(
+                        plugin_path, error)
+                    )
 
             plugin_config = self.config.get(cls.__name__, {})
             plugin = cls(slack_client=self.slack_client, plugin_config=plugin_config)  # instatiate!

setup.py

@@ -3,16 +3,15 @@
 
 setup(
     name='rtmbot',
-    version='0.2.11',
+    version='0.3.0',
     description='A Slack bot written in python that connects via the RTM API.',
     author='Ryan Huber and Jeff Ammons',
     author_email='[email protected]',
     url='https://github.com/slackhq/python-rtmbot',
     packages=find_packages(),
     entry_points={'console_scripts': ['rtmbot=rtmbot.bin.run_rtmbot:main']},
     install_requires=[
-        'python-daemon',
-        'pyyaml',
-        'slackclient'
+        'pyyaml>=3, <4',
+        'slackclient>=1, <2'
     ]
  )