Update and modernize project.

Author: tkem

.github/workflows/ci.yml

@@ -0,0 +1,22 @@
+name: CI
+
+on: [push, pull_request, workflow_dispatch]
+
+jobs:
+  main:
+    name: Python ${{ matrix.python }}
+    runs-on: ubuntu-20.04
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ["3.7", "3.8", "3.9", "3.10", "3.11", "pypy-3.7", "pypy-3.8"]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python }}
+      - run: python -m pip install coverage tox
+      - run: python -m tox
+      - uses: codecov/codecov-action@v3
+        with:
+          name: ${{ matrix.python }}

.gitignore

@@ -1,4 +1,5 @@
 *.egg-info
+*.log
 *.pyc
 *.swp
 .cache/

.travis.yml

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2017 Thomas Kemmer
+Copyright (c) 2015-2022 Thomas Kemmer
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

LICENSE

@@ -5,22 +5,27 @@ carreralib
    :target: https://pypi.org/project/carreralib/
    :alt: Latest PyPI version
 
+.. image:: https://img.shields.io/github/workflow/status/tkem/carreralib/CI
+   :target: https://github.com/tkem/carreralib/actions/workflows/ci.yml
+   :alt: CI build status
+
 .. image:: https://img.shields.io/readthedocs/carreralib
    :target: http://carreralib.readthedocs.io/
    :alt: Documentation build status
 
-.. image:: http://img.shields.io/travis/tkem/carreralib
-   :target: https://travis-ci.org/tkem/carreralib/
-   :alt: Travis CI build status
-
-.. image:: http://img.shields.io/coveralls/tkem/carreralib
-   :target: https://coveralls.io/r/tkem/carreralib
+.. image:: https://img.shields.io/codecov/c/github/tkem/carreralib/master.svg
+   :target: https://codecov.io/gh/tkem/carreralib
    :alt: Test coverage
 
-.. image:: https://img.shields.io/github/license/tkem/carreralib
-   :target: http://raw.github.com/tkem/carreralib/master/LICENSE
+.. image:: https://img.shields.io/github/license/tkem/cachetools
+   :target: https://raw.github.com/tkem/cachetools/master/LICENSE
    :alt: License
 
+.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
+   :target: https://github.com/psf/black
+   :alt: Code style: black
+
+
 This module provides a Python interface to Carrera(R) DIGITAL 124/132
 slotcar systems connected via serial port or Bluetooth.
 
@@ -76,12 +81,12 @@ Project Resources
 License
 ------------------------------------------------------------------------
 
-Copyright (c) 2015-2020 Thomas Kemmer.
+Copyright (c) 2015-2022 Thomas Kemmer.
 
 Licensed under the `MIT License`_.
 
-Carrera and Carrera AppConnect are registered trademarks of Stadlbauer
-Marketing + Vertrieb GmbH.
+Carrera and Carrera AppConnect are registered trademarks of Carrera
+Toys GmbH.
 
 Thanks to Stephan Heß (a.k.a. slotbaer_) for doing all the hard work.
 

README.rst

@@ -1,24 +1,30 @@
+import pathlib
+import sys
+
+basedir = pathlib.Path(__file__).parent.parent
+
+sys.path.insert(0, str((basedir / "src").resolve()))
+
+
 def get_version():
     import configparser
-    import pathlib
 
     cp = configparser.ConfigParser()
-    # Python 3.5 ConfigParser does not accept Path as filename
-    cp.read(str(pathlib.Path(__file__).parent.parent / "setup.cfg"))
+    cp.read(basedir / "setup.cfg")
     return cp["metadata"]["version"]
 
 
-project = 'carreralib'
-copyright = '2015-2020 Thomas Kemmer'
+project = "carreralib"
+copyright = "2015-2022 Thomas Kemmer"
 version = get_version()
 release = version
 
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.coverage',
-    'sphinx.ext.doctest',
-    'sphinx.ext.todo'
+    "sphinx.ext.autodoc",
+    "sphinx.ext.coverage",
+    "sphinx.ext.doctest",
+    "sphinx.ext.todo",
 ]
-exclude_patterns = ['_build']
-master_doc = 'index'
-html_theme = 'default'
+exclude_patterns = ["_build"]
+master_doc = "index"
+html_theme = "default"

carreralib/__init__.py

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools >= 46.4.0", "wheel"]
+build-backend = "setuptools.build_meta"

docs/conf.py

@@ -1,6 +1,6 @@
 [metadata]
 name = carreralib
-version = 0.7.0
+version = attr: carreralib.__version__
 url = https://github.com/tkem/carreralib/
 author = Thomas Kemmer
 author_email = [email protected]
@@ -13,26 +13,37 @@ classifiers =
     Environment :: Other Environment
     Intended Audience :: Developers
     License :: OSI Approved :: MIT License
-    Operating System :: POSIX :: Linux
+    Operating System :: POSIX
+    Operating System :: Microsoft :: Windows
+    Operating System :: MacOS :: MacOS X
     Programming Language :: Python
     Programming Language :: Python :: 3
-    Programming Language :: Python :: 3.5
-    Programming Language :: Python :: 3.6
     Programming Language :: Python :: 3.7
     Programming Language :: Python :: 3.8
+    Programming Language :: Python :: 3.9
+    Programming Language :: Python :: 3.10
+    Programming Language :: Python :: 3.11
     Topic :: Software Development :: Libraries :: Python Modules
 
 [options]
+package_dir =
+    = src
 packages = find:
-python_requires = ~= 3.5
+install_requires =
+    pyserial
+python_requires = ~= 3.7
 
 [options.packages.find]
-exclude =
-    tests
-    tests.*
+where = src
 
 [flake8]
-exclude = .git, .tox
+max-line-length = 80
+exclude = .git, .tox, build
+select = C, E, F, W, B, B950, I, N
+# B008: function calls in argument defaults
+# E203: whitespace before ':' (black)
+# E501: line too long (black)
+ignore = B008, E203, E501
 
 [build_sphinx]
 source-dir = docs/

pyproject.toml

@@ -0,0 +1,9 @@
+"""Python interface to Carrera(R) DIGITAL 124/132 slotcar systems."""
+
+from . import connection
+from . import protocol
+from .cu import ControlUnit
+
+__all__ = ("ControlUnit", "connection", "protocol")
+
+__version__ = "0.7.0"

setup.cfg

@@ -1,5 +1,3 @@
-from __future__ import unicode_literals
-
 import argparse
 import contextlib
 import curses
@@ -17,27 +15,31 @@ def posgetter(driver):
 
 def formattime(time, longfmt=False):
     if time is None:
-        return 'n/a'
+        return "n/a"
     s = time // 1000
     ms = time % 1000
 
     if not longfmt:
-        return '%d.%03d' % (s, ms)
+        return "%d.%03d" % (s, ms)
     elif s < 3600:
-        return '%d:%02d.%03d' % (s // 60, s % 60, ms)
+        return "%d:%02d.%03d" % (s // 60, s % 60, ms)
     else:
-        return '%d:%02d:%02d.%03d' % (s // 3600, (s // 60) % 60, s % 60, ms)
+        return "%d:%02d:%02d.%03d" % (s // 3600, (s // 60) % 60, s % 60, ms)
 
 
 class RMS(object):
 
-    HEADER = 'Pos No         Time  Lap time  Best lap Laps Pit Fuel'
-    FORMAT1 = ('{pos:<4}#{car:<2}{time:>12}{laptime:>10}{bestlap:>10}' +
-               '{laps:>5}{pits:>4}{fuel:>5.0%}')
-    FORMAT2 = ('{pos:<4}#{car:<2}{time:>12}{laptime:>10}{bestlap:>10}' +
-               '{laps:>5} n/a  n/a')
-    FOOTER1 = ' * * * * *  SPACE to start/pause, ESC for pace car'
-    FOOTER2 = ' [R]eset, [S]peed, [B]rake, [F]uel, [C]ode, [Q]uit'
+    HEADER = "Pos No         Time  Lap time  Best lap Laps Pit Fuel"
+    FORMAT1 = "%s%s" % (
+        "{pos:<4}#{car:<2}{time:>12}{laptime:>10}{bestlap:>10}",
+        "{laps:>5}{pits:>4}{fuel:>5.0%}",
+    )
+    FORMAT2 = "%s%s" % (
+        "{pos:<4}#{car:<2}{time:>12}{laptime:>10}{bestlap:>10}",
+        "{laps:>5} n/a  n/a",
+    )
+    FOOTER1 = " * * * * *  SPACE to start/pause, ESC for pace car"
+    FOOTER2 = " [R]eset, [S]peed, [B]rake, [F]uel, [C]ode, [Q]uit"
 
     # CU reports zero fuel for all cars unless pit lane adapter is connected
     # FUEL_MASK = ControlUnit.Status.FUEL_MODE | ControlUnit.Status.REAL_MODE
@@ -90,21 +92,21 @@ def run(self):
             try:
                 self.update()
                 c = self.window.getch()
-                if c == ord('q'):
+                if c == ord("q"):
                     break
-                elif c == ord('r'):
+                elif c == ord("r"):
                     self.reset()
-                elif c == ord(' '):
+                elif c == ord(" "):
                     self.cu.start()
-                elif (c == 27):  # ESC
+                elif c == 27:  # ESC
                     self.cu.request(ControlUnit.PACE_CAR_KEY)
-                elif c == ord('s'):
+                elif c == ord("s"):
                     self.cu.request(ControlUnit.SPEED_KEY)
-                elif c == ord('b'):
+                elif c == ord("b"):
                     self.cu.request(ControlUnit.BRAKE_KEY)
-                elif c == ord('f'):
+                elif c == ord("f"):
                     self.cu.request(ControlUnit.FUEL_KEY)
-                elif c == ord('c'):
+                elif c == ord("c"):
                     self.cu.request(ControlUnit.CODE_KEY)
                 data = self.cu.request()
                 # prevent counting duplicate laps
@@ -115,7 +117,7 @@ def run(self):
                 elif isinstance(data, ControlUnit.Timer):
                     self.handle_timer(data)
                 else:
-                    logging.warn('Unknown data from CU: ' + data)
+                    logging.warn("Unknown data from CU: " + data)
                 last = data
             except select.error:
                 pass
@@ -166,47 +168,56 @@ def update(self, blink=lambda: (time.time() * 2) % 2 == 0):
                 leader = driver
                 t = formattime(driver.time - self.start, True)
             elif driver.laps == leader.laps:
-                t = '+%ss' % formattime(driver.time - leader.time)
+                t = "+%ss" % formattime(driver.time - leader.time)
             else:
                 gap = leader.laps - driver.laps
-                t = '+%d Lap%s' % (gap, 's' if gap != 1 else '')
+                t = "+%d Lap%s" % (gap, "s" if gap != 1 else "")
             if (self.status.mode & self.FUEL_MASK) != 0:
                 text = self.FORMAT1.format(
-                    pos=pos, car=driver.num, time=t, laps=driver.laps,
+                    pos=pos,
+                    car=driver.num,
+                    time=t,
+                    laps=driver.laps,
                     laptime=formattime(driver.laptime),
                     bestlap=formattime(driver.bestlap),
-                    fuel=driver.fuel/15.0,
-                    pits=driver.pits
+                    fuel=driver.fuel / 15.0,
+                    pits=driver.pits,
                 )
             else:
                 text = self.FORMAT2.format(
-                    pos=pos, car=driver.num, time=t, laps=driver.laps,
+                    pos=pos,
+                    car=driver.num,
+                    time=t,
+                    laps=driver.laps,
                     laptime=formattime(driver.laptime),
-                    bestlap=formattime(driver.bestlap)
+                    bestlap=formattime(driver.bestlap),
                 )
             window.addnstr(pos, 0, text, ncols)
         window.refresh()
 
 
-parser = argparse.ArgumentParser(prog='python -m carreralib')
-parser.add_argument('device', metavar='DEVICE')
-parser.add_argument('-l', '--logfile', default='carreralib.log')
-parser.add_argument('-t', '--timeout', default=1.0, type=float)
-parser.add_argument('-v', '--verbose', action='store_true')
+parser = argparse.ArgumentParser(prog="python -m carreralib")
+parser.add_argument("device", metavar="DEVICE")
+parser.add_argument("-l", "--logfile", default="carreralib.log")
+parser.add_argument("-t", "--timeout", default=1.0, type=float)
+parser.add_argument("-v", "--verbose", action="store_true")
 args = parser.parse_args()
 
-logging.basicConfig(level=logging.DEBUG if args.verbose else logging.WARN,
-                    filename=args.logfile,
-                    format='%(asctime)s: %(message)s')
+logging.basicConfig(
+    level=logging.DEBUG if args.verbose else logging.WARN,
+    filename=args.logfile,
+    format="%(asctime)s: %(message)s",
+)
 
 with contextlib.closing(ControlUnit(args.device, timeout=args.timeout)) as cu:
-    print('CU version %s' % cu.version())
+    print("CU version %s" % cu.version())
 
     def run(win):
         curses.curs_set(0)
         curses.init_pair(1, curses.COLOR_RED, curses.COLOR_BLACK)
         rms = RMS(cu, win)
         rms.run()
+
     try:
         curses.wrapper(run)
     except KeyboardInterrupt: