Fix IdeEventHandler not working with arbitrary keys

Fix a Sphinx warning message

README.md

@@ -80,6 +80,6 @@ The TFW message format:
 
 Most of the components you need have docstrings included (hang on tight, this is work in progress) – refer to them for usage info.
 
-In the `docs` folder you can find our Sphinx-based API documentation, which you can build using the included `Makefile` (you need to have Sphinx installed, please reach out to us if you have trouble building the docs).
+In the `docs` folder you can find our Sphinx-based API documentation, which you can build using the `hack/tfw.sh` script in the [test-tutorial-framework](https://github.com/avatao-content/test-tutorial-framework) repository.
 
-To get started you should take a look at the [test-tutorial-framework](https://github.com/avatao-content/test-tutorial-framework) repository, which serves as an example project as well.
+To get started you should take a look at [test-tutorial-framework](https://github.com/avatao-content/test-tutorial-framework), which serves as an example project as well.

lib/tfw/components/directory_monitor.py

@@ -15,8 +15,8 @@ LOG = logging.getLogger(__name__)
 
 
 class DirectoryMonitor(ObserverMixin):
-    def __init__(self, directories):
+    def __init__(self, ide_key, directories):
-        self.eventhandler = IdeReloadWatchdogEventHandler()
+        self.eventhandler = IdeReloadWatchdogEventHandler(ide_key)
         for directory in directories:
             self.observer.schedule(self.eventhandler, directory, recursive=True)
 
@@ -44,8 +44,9 @@ class DirectoryMonitor(ObserverMixin):
 
 
 class IdeReloadWatchdogEventHandler(FileSystemWatchdogEventHandler):
-    def __init__(self):
+    def __init__(self, ide_key):
         super().__init__()
+        self.ide_key = ide_key
         self.uplink = ServerUplinkConnector()
         self._paused = False
         self.ignore = 0
@@ -65,7 +66,7 @@ class IdeReloadWatchdogEventHandler(FileSystemWatchdogEventHandler):
             return
         LOG.debug(event)
         self.uplink.send({
-            'key': 'ide',
+            'key': self.ide_key,
             'data': {'command': 'reload'}
         })
 

lib/tfw/components/directory_monitoring_event_handler.py

@@ -15,7 +15,12 @@ class DirectoryMonitoringEventHandler(EventHandlerBase, MonitorManagerMixin):
     def __init__(self, key, directory):
         super().__init__(key)
         self._directory = directory
-        MonitorManagerMixin.__init__(self, DirectoryMonitor, self._directory)
+        MonitorManagerMixin.__init__(
+            self,
+            DirectoryMonitor,
+            key,
+            self._directory
+        )
 
         self.commands = {
             'pause':     self.pause,

lib/tfw/components/ide_event_handler.py

@@ -141,6 +141,7 @@ class IdeEventHandler(EventHandlerBase, MonitorManagerMixin):
         MonitorManagerMixin.__init__(
             self,
             DirectoryMonitor,
+            self.key,
             self.filemanager.allowed_directories
         )
 

setup.py

@@ -2,7 +2,6 @@ from os.path import dirname, realpath, join
 
 from setuptools import setup, find_packages
 
-
 here = dirname(realpath(__file__))
 
 with open(join(here, 'VERSION'), 'r') as ifile:
@@ -10,14 +9,21 @@ with open(join(here, 'VERSION'), 'r') as ifile:
 with open(join(here, 'requirements.txt'), 'r') as ifile:
     requirements = ifile.read().splitlines()
 
-setup(name='tfw',
+setup(
-      version=version,
+    name = 'tfw',
-      description='Avatao tutorial-framework',
+    version = version,
-      url='https://github.com/avatao-content/baseimage-tutorial-framework',
+    description = 'Avatao tutorial-framework',
-      author='Avatao.com Innovative Learning Kft.',
+    url = 'https://github.com/avatao-content/baseimage-tutorial-framework',
-      author_email='support@avatao.com',
+    author = 'Avatao.com Innovative Learning Kft.',
-      license='custom',
+    author_email = 'support@avatao.com',
-      packages=find_packages('lib'),
+    license = 'custom',
-      package_dir={'': 'lib'},
+    packages = find_packages('lib'),
-      install_requires=requirements,
+    package_dir = {'': 'lib'},
-      zip_safe=False)
+    install_requires = requirements,
+    extras_require = {
+        'docs': [
+            'sphinx >= 1.7.0',
+        ],
+    },
+    zip_safe = False,
+)