Merge pull request #2 from confirm/travis-ci

Travis ci

.travis.yml

@@ -0,0 +1,19 @@
+language: python
+
+python:
+  - 2.7
+
+install:
+  # Workaround for pi-rc522 dependency issue.
+  - pip install spidev RPi.GPIO
+
+  # Install package develop
+  - pip install -e .[develop]
+
+script:
+    # Code style checks.
+    - pycodestyle mopidy_pummeluff
+    - pylint mopidy_pummeluff
+
+    # Build check.
+    - python setup.py build

mopidy_pummeluff/cards.py

@@ -162,6 +162,20 @@ class Card(object):
 
         return card_dict
 
+    def action(self, mopidy_core):  # pylint: disable=unused-argument
+        '''
+        Action method which is executed when the card is detected on the RFID
+        reader.
+
+        :param mopidy.core.Core mopidy_core: The mopidy core instance
+
+        :raises NotImplementedError: Always raised when method not implemented
+        '''
+        cls   = self.__class__.__name__
+        error = 'Missing action() method in the %s class'
+        LOGGER.error(error, cls)
+        raise NotImplementedError(error % cls)
+
 
 class TracklistCard(Card):
     '''
@@ -193,7 +207,7 @@ class VolumeCard(Card):
 
         :param mixed parameter: The parameter
 
-        :raises: ValueError in case the parameter is invalid
+        :raises ValueError: When parameter is invalid
         '''
         try:
             number = int(parameter)
@@ -222,6 +236,8 @@ class StopCard(Card):
     def action(self, mopidy_core):  # pylint: disable=no-self-use
         '''
         Stop playback.
+
+        :param mopidy.core.Core mopidy_core: The mopidy core instance
         '''
         LOGGER.info('Stopping playback')
         mopidy_core.playback.stop()
@@ -235,6 +251,8 @@ class PauseCard(Card):
     def action(self, mopidy_core):  # pylint: disable=no-self-use
         '''
         Pause or resume the playback.
+
+        :param mopidy.core.Core mopidy_core: The mopidy core instance
         '''
         playback = mopidy_core.playback
 

mopidy_pummeluff/registry.py

@@ -59,7 +59,7 @@ class RegistryDict(dict):
         '''
         Read registry from disk.
 
-        :raises: IOError when registry file on disk is missing
+        :raises IOError: When registry file on disk is missing
         '''
         LOGGER.debug('Reading registry from %s', self.registry_path)
 

mopidy_pummeluff/rfid_reader.py

@@ -5,7 +5,7 @@ Python card reader module.
 
 from __future__ import absolute_import, unicode_literals, print_function
 
-from RPi.GPIO import cleanup
+from RPi.GPIO import cleanup  # pylint: disable=no-name-in-module
 from pirc522 import RFID
 
 
@@ -44,5 +44,5 @@ class RFIDReader(RFID):
         if error:
             raise ReadError('Could not read UID')
 
-        uid = '{0[0]:02X}{0[1]:02X}{0[2]:02X}{0[3]:02X}'.format(uid_chunks)
+        uid = '{0[0]:02X}{0[1]:02X}{0[2]:02X}{0[3]:02X}'.format(uid_chunks)  # pylint: disable=invalid-format-index
         return uid

mopidy_pummeluff/web.py

@@ -22,7 +22,7 @@ from .frontend import CardReader
 LOGGER = getLogger(__name__)
 
 
-class LatestHandler(RequestHandler):
+class LatestHandler(RequestHandler):  # pylint: disable=abstract-method
     '''
     Request handler which returns the latest scanned card.
     '''
@@ -61,7 +61,7 @@ class LatestHandler(RequestHandler):
         self.write(dumps(data))
 
 
-class RegistryHandler(RequestHandler):
+class RegistryHandler(RequestHandler):  # pylint: disable=abstract-method
     '''
     Request handler which returns all registered cards.
     '''
@@ -93,7 +93,7 @@ class RegistryHandler(RequestHandler):
         self.write(dumps(data))
 
 
-class RegisterHandler(RequestHandler):
+class RegisterHandler(RequestHandler):  # pylint: disable=abstract-method
     '''
     Request handler which registers an RFID card in the registry.
     '''
@@ -142,7 +142,7 @@ class RegisterHandler(RequestHandler):
         self.post()
 
 
-class TypesHandler(RequestHandler):
+class TypesHandler(RequestHandler):  # pylint: disable=abstract-method
     '''
     Request handler which returns all card types.
     '''

requirements.txt

@@ -0,0 +1,2 @@
+Mopidy >= 2.2.2
+pi-rc522 == 2.2.1

requirements_dev.txt

@@ -0,0 +1,2 @@
+pycodestyle==2.5.0
+pylint==1.9.4

setup.py

@@ -7,6 +7,12 @@ from __future__ import absolute_import, unicode_literals, print_function
 
 from setuptools import setup, find_packages
 
+with open('requirements.txt') as f:
+    requirements = f.read().strip().split('\n')
+
+with open('requirements_dev.txt') as f:
+    requirements_dev = f.read().strip().split('\n')
+
 setup(
     name='Mopidy-Pummeluff',
     use_scm_version=True,
@@ -21,11 +27,10 @@ setup(
     setup_requires=[
         'setuptools_scm',
     ],
-    install_requires=[
-        'setuptools',
-        'Mopidy >= 2.2.2',
-        'pi-rc522 == 2.2.1',
-    ],
+    install_requires=['setuptools'] + requirements,
+    extras_require={
+        'develop': requirements_dev
+    },
     entry_points={
         b'mopidy.ext': [
             'pummeluff = mopidy_pummeluff:Extension',