switch to poetry (#135)

.github/workflows/run-tests.yml

@@ -5,13 +5,16 @@ on:
   pull_request_target:
   workflow_dispatch:
 
+env:
+  POETRY_VERSION: "1.3.1"
+
 jobs:
   deploy:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
 
     env:
       PYTHON_VERSION: ${{ matrix.python-version }}
@@ -24,30 +27,44 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
+      # Poetry cache depends on OS, Python version and Poetry version.
+      - name: Cache Poetry cache
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pypoetry
+          key: poetry-cache-${{ runner.os }}-${{ env.PYTHON_VERSION }}-${{ env.POETRY_VERSION }}
+
+      # virtualenv cache should depends on OS, Python version and `poetry.lock` (and optionally workflow files).
+      - name: Cache Packages
+        uses: actions/cache@v3
+        with:
+          path: ~/.local
+          key: poetry-${{ runner.os }}-${{ env.PYTHON_VERSION }}-${{ hashFiles('**/poetry.lock') }}
+
+      - name: Install and configure Poetry
+        uses: snok/install-poetry@v1.3.3
+        with:
+          version: ${{ env.POETRY_VERSION }}
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+
+      - name: Add poetry to windows path
+        if: "startsWith(runner.os, 'windows')"
+        run: |
+          echo "C:\Users\runneradmin\.local\bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
+
       - name: Install dependencies
         run: |
-          pip install -U pip numpy cython mypy
+          poetry install
-          pip install -U pytest codecov pytest-cov
-          pip install .
 
       - name: Type checking
         if: ${{ env.PYTHON_VERSION != '3.7' }}
         run: |
-          mypy pyModeS
+          poetry run mypy pyModeS
 
-      - name: Run tests (without Cython)
+      - name: Run tests
         run: |
-          pytest tests --cov --cov-report term-missing
+          poetry run pytest tests --cov --cov-report term-missing
-
-      - name: Install with Cython
-        run: |
-          pip install -U cython
-          pip uninstall -y pymodes
-          pip install .
-
-      - name: Run tests (with Cython)
-        run: |
-          pytest tests
 
       - name: Upload coverage to Codecov
         if: ${{ github.event_name != 'pull_request_target' && env.PYTHON_VERSION == '3.10' }}

README.rst

@@ -94,13 +94,13 @@ If you want to make use of the (faster) c module, install ``pyModeS`` as follows
   # conda (compiled) version
   conda install -c conda-forge pymodes
 
-  # stable version (to be compiled on your side)
+  # stable version
-  pip install pyModeS[fast]
+  pip install pyModeS
 
   # development version
   git clone https://github.com/junzis/pyModeS
   cd pyModeS
-  pip install .[fast]
+  poetry install -E rtlsdr
 
 
 View live traffic (modeslive)

build.py

@@ -0,0 +1,77 @@
+import os
+import shutil
+import sys
+from distutils.core import Distribution, Extension
+from distutils.command import build_ext
+
+from Cython.Build import cythonize
+
+
+def build() -> None:
+    compile_args = []
+
+    if sys.platform == "linux":
+        compile_args += [
+            "-march=native",
+            "-O3",
+            "-msse",
+            "-msse2",
+            "-mfma",
+            "-mfpmath=sse",
+            "-Wno-pointer-sign",
+            "-Wno-unused-variable",
+        ]
+
+    extensions = [
+        Extension(
+            "pyModeS.c_common",
+            ["pyModeS/c_common.pyx"],
+            extra_compile_args=compile_args,
+        ),
+        Extension(
+            "pyModeS.decoder.flarm.decode",
+            [
+                "pyModeS/decoder/flarm/decode.pyx",
+                "pyModeS/decoder/flarm/core.c",
+            ],
+            extra_compile_args=compile_args,
+            include_dirs=["pyModeS/decoder/flarm"],
+        ),
+        # Extension(
+        #     "pyModeS.extra.demod2400.core",
+        #     [
+        #         "pyModeS/extra/demod2400/core.pyx",
+        #         "pyModeS/extra/demod2400/demod2400.c",
+        #     ],
+        #     extra_compile_args=compile_args,
+        #     include_dirs=["pyModeS/extra/demod2400"],
+        #     libraries=["m"],
+        # ),
+    ]
+
+    ext_modules = cythonize(
+        extensions,
+        compiler_directives={"binding": True, "language_level": 3},
+    )
+
+    distribution = Distribution(
+        {"name": "extended", "ext_modules": ext_modules}
+    )
+    distribution.package_dir = "extended"  # type: ignore
+
+    cmd = build_ext.build_ext(distribution)
+    cmd.verbose = True  # type: ignore
+    cmd.ensure_finalized()  # type: ignore
+    cmd.run()
+
+    # Copy built extensions back to the project
+    for output in cmd.get_outputs():
+        relative_extension = os.path.relpath(output, cmd.build_lib)
+        shutil.copyfile(output, relative_extension)
+        mode = os.stat(relative_extension).st_mode
+        mode |= (mode & 0o444) >> 2
+        os.chmod(relative_extension, mode)
+
+
+if __name__ == "__main__":
+    build()

pyModeS/decoder/flarm/decode.pyx

@@ -1,6 +1,7 @@
-from core cimport make_key as c_make_key, btea as c_btea
 from cpython cimport array
 
+from .core cimport make_key as c_make_key, btea as c_btea
+
 import array
 import math
 from ctypes import c_byte

pyModeS/streamer/modeslive

@@ -1,156 +0,0 @@
-#!/usr/bin/env python
-
-import os
-import sys
-import time
-import argparse
-import curses
-import signal
-import multiprocessing
-from pyModeS.streamer.decode import Decode
-from pyModeS.streamer.screen import Screen
-from pyModeS.streamer.source import NetSource, RtlSdrSource
-
-
-support_rawtypes = ["raw", "beast", "skysense"]
-
-parser = argparse.ArgumentParser()
-parser.add_argument(
-    "--source",
-    help='Choose data source, "rtlsdr" or "net"',
-    required=True,
-    default="net",
-)
-parser.add_argument(
-    "--connect",
-    help="Define server, port and data type. Supported data types are: {}".format(
-        support_rawtypes
-    ),
-    nargs=3,
-    metavar=("SERVER", "PORT", "DATATYPE"),
-    default=None,
-    required=False,
-)
-parser.add_argument(
-    "--latlon",
-    help="Receiver latitude and longitude, needed for the surface position, default none",
-    nargs=2,
-    metavar=("LAT", "LON"),
-    default=None,
-    required=False,
-)
-parser.add_argument(
-    "--show-uncertainty",
-    dest="uncertainty",
-    help="Display uncertainty values, default off",
-    action="store_true",
-    required=False,
-    default=False,
-)
-parser.add_argument(
-    "--dumpto",
-    help="Folder to dump decoded output, default none",
-    required=False,
-    default=None,
-)
-args = parser.parse_args()
-
-SOURCE = args.source
-LATLON = args.latlon
-UNCERTAINTY = args.uncertainty
-DUMPTO = args.dumpto
-
-if SOURCE == "rtlsdr":
-    pass
-elif SOURCE == "net":
-    if args.connect is None:
-        print("Error: --connect argument must not be empty.")
-    else:
-        SERVER, PORT, DATATYPE = args.connect
-        if DATATYPE not in support_rawtypes:
-            print("Data type not supported, available ones are %s" % support_rawtypes)
-
-else:
-    print('Source must be "rtlsdr" or "net".')
-    sys.exit(1)
-
-if DUMPTO is not None:
-    # append to current folder except root is given
-    if DUMPTO[0] != "/":
-        DUMPTO = os.getcwd() + "/" + DUMPTO
-
-    if not os.path.isdir(DUMPTO):
-        print("Error: dump folder (%s) does not exist" % DUMPTO)
-        sys.exit(1)
-
-
-# redirect all stdout to null, avoiding messing up with the screen
-sys.stdout = open(os.devnull, "w")
-
-
-raw_pipe_in, raw_pipe_out = multiprocessing.Pipe()
-ac_pipe_in, ac_pipe_out = multiprocessing.Pipe()
-exception_queue = multiprocessing.Queue()
-stop_flag = multiprocessing.Value("b", False)
-
-if SOURCE == "net":
-    source = NetSource(host=SERVER, port=PORT, rawtype=DATATYPE)
-elif SOURCE == "rtlsdr":
-    source = RtlSdrSource()
-
-
-recv_process = multiprocessing.Process(
-    target=source.run, args=(raw_pipe_in, stop_flag, exception_queue)
-)
-
-
-decode = Decode(latlon=LATLON, dumpto=DUMPTO)
-decode_process = multiprocessing.Process(
-    target=decode.run, args=(raw_pipe_out, ac_pipe_in, exception_queue)
-)
-
-screen = Screen(uncertainty=UNCERTAINTY)
-screen_process = multiprocessing.Process(
-    target=screen.run, args=(ac_pipe_out, exception_queue)
-)
-
-
-def shutdown():
-    stop_flag.value = True
-    curses.endwin()
-    sys.stdout = sys.__stdout__
-    recv_process.terminate()
-    decode_process.terminate()
-    screen_process.terminate()
-    recv_process.join()
-    decode_process.join()
-    screen_process.join()
-
-
-def closeall(signal, frame):
-    print("KeyboardInterrupt (ID: {}). Cleaning up...".format(signal))
-    shutdown()
-    sys.exit(0)
-
-
-signal.signal(signal.SIGINT, closeall)
-
-recv_process.start()
-decode_process.start()
-screen_process.start()
-
-
-while True:
-    if (
-        (not recv_process.is_alive())
-        or (not decode_process.is_alive())
-        or (not screen_process.is_alive())
-    ):
-        shutdown()
-        while not exception_queue.empty():
-            trackback = exception_queue.get()
-            print(trackback)
-
-        sys.exit(1)
-
-    time.sleep(0.01)

pyModeS/streamer/modeslive.py

@@ -0,0 +1,155 @@
+#!/usr/bin/env python
+
+import os
+import sys
+import time
+import argparse
+import curses
+import signal
+import multiprocessing
+from pyModeS.streamer.decode import Decode
+from pyModeS.streamer.screen import Screen
+from pyModeS.streamer.source import NetSource, RtlSdrSource  # , RtlSdrSource24
+
+
+def main():
+
+    support_rawtypes = ["raw", "beast", "skysense"]
+
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        "--source",
+        help='Choose data source, "rtlsdr", "rtlsdr24" or "net"',
+        required=True,
+        default="net",
+    )
+    parser.add_argument(
+        "--connect",
+        help="Define server, port and data type. Supported data types are: {}".format(
+            support_rawtypes
+        ),
+        nargs=3,
+        metavar=("SERVER", "PORT", "DATATYPE"),
+        default=None,
+        required=False,
+    )
+    parser.add_argument(
+        "--latlon",
+        help="Receiver latitude and longitude, needed for the surface position, default none",
+        nargs=2,
+        metavar=("LAT", "LON"),
+        default=None,
+        required=False,
+    )
+    parser.add_argument(
+        "--show-uncertainty",
+        dest="uncertainty",
+        help="Display uncertainty values, default off",
+        action="store_true",
+        required=False,
+        default=False,
+    )
+    parser.add_argument(
+        "--dumpto",
+        help="Folder to dump decoded output, default none",
+        required=False,
+        default=None,
+    )
+    args = parser.parse_args()
+
+    SOURCE = args.source
+    LATLON = args.latlon
+    UNCERTAINTY = args.uncertainty
+    DUMPTO = args.dumpto
+
+    if SOURCE in ["rtlsdr", "rtlsdr24"]:
+        pass
+    elif SOURCE == "net":
+        if args.connect is None:
+            print("Error: --connect argument must not be empty.")
+        else:
+            SERVER, PORT, DATATYPE = args.connect
+            if DATATYPE not in support_rawtypes:
+                print(
+                    "Data type not supported, available ones are %s"
+                    % support_rawtypes
+                )
+
+    else:
+        print('Source must be "rtlsdr" or "net".')
+        sys.exit(1)
+
+    if DUMPTO is not None:
+        # append to current folder except root is given
+        if DUMPTO[0] != "/":
+            DUMPTO = os.getcwd() + "/" + DUMPTO
+
+        if not os.path.isdir(DUMPTO):
+            print("Error: dump folder (%s) does not exist" % DUMPTO)
+            sys.exit(1)
+
+    # redirect all stdout to null, avoiding messing up with the screen
+    sys.stdout = open(os.devnull, "w")
+
+    raw_pipe_in, raw_pipe_out = multiprocessing.Pipe()
+    ac_pipe_in, ac_pipe_out = multiprocessing.Pipe()
+    exception_queue = multiprocessing.Queue()
+    stop_flag = multiprocessing.Value("b", False)
+
+    if SOURCE == "net":
+        source = NetSource(host=SERVER, port=PORT, rawtype=DATATYPE)
+    elif SOURCE == "rtlsdr":
+        source = RtlSdrSource()
+    # elif SOURCE == "rtlsdr24":
+    #     source = RtlSdrSource24()
+
+    recv_process = multiprocessing.Process(
+        target=source.run, args=(raw_pipe_in, stop_flag, exception_queue)
+    )
+
+    decode = Decode(latlon=LATLON, dumpto=DUMPTO)
+    decode_process = multiprocessing.Process(
+        target=decode.run, args=(raw_pipe_out, ac_pipe_in, exception_queue)
+    )
+
+    screen = Screen(uncertainty=UNCERTAINTY)
+    screen_process = multiprocessing.Process(
+        target=screen.run, args=(ac_pipe_out, exception_queue)
+    )
+
+    def shutdown():
+        stop_flag.value = True
+        curses.endwin()
+        sys.stdout = sys.__stdout__
+        recv_process.terminate()
+        decode_process.terminate()
+        screen_process.terminate()
+        recv_process.join()
+        decode_process.join()
+        screen_process.join()
+
+    def closeall(signal, frame):
+        print("KeyboardInterrupt (ID: {}). Cleaning up...".format(signal))
+        shutdown()
+        sys.exit(0)
+
+    signal.signal(signal.SIGINT, closeall)
+
+    recv_process.start()
+    decode_process.start()
+    screen_process.start()
+
+    while True:
+        if (
+            (not recv_process.is_alive())
+            or (not decode_process.is_alive())
+            or (not screen_process.is_alive())
+        ):
+            shutdown()
+            while not exception_queue.empty():
+                trackback = exception_queue.get()
+                print(trackback)
+
+            sys.exit(1)
+
+        time.sleep(0.01)

pyproject.toml

@@ -0,0 +1,66 @@
+[tool.poetry]
+name = "pyModeS"
+version = "2.11"
+description = "Python Mode-S and ADS-B Decoder"
+authors = ["Junzi Sun <j.sun-1@tudelft.nl>"]
+license = "GNU GPL v3"
+readme = "README.rst"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries",
+    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+    "Programming Language :: Python :: 3",
+    "Typing :: Typed",
+]
+packages = [
+    { include = "pyModeS", from = "." },
+]
+include = [
+    "LICENSE",
+    "*.pyx",
+    "*.pxd",
+    "*.pyi",
+    "py.typed",
+    { path = "src/pyModeS/**/*.so", format = "wheel" }
+]
+
+[tool.poetry.build]
+generate-setup-file = false
+script = "build.py"
+
+[tool.poetry.scripts]
+modeslive = "pyModeS.streamer.modeslive:main"
+
+[tool.poetry.dependencies]
+python = "^3.8"
+numpy = "^1.24"
+pyzmq = "^24.0"
+pyrtlsdr = {version = "^0.2.93", optional = true}
+
+[tool.poetry.group.dev.dependencies]
+Cython = "^0.29.32"
+mypy = "^0.991"
+flake8 = "^5.0.0"
+black = "^22.12.0"
+isort = "^5.11.4"
+pytest = "^7.2.0"
+pytest-cov = "^4.0.0"
+codecov = "^2.1.12"
+ipykernel = "^6.20.0"
+
+[tool.poetry.extras]
+rtlsdr = ["pyrtlsdr"]
+
+[tool.black]
+line-length = 80
+target_version = ['py38', 'py39', 'py310', 'py311']
+include = '\.pyi?$'
+
+[tool.isort]
+line_length = 80
+profile = "black"
+
+[build-system]
+requires = ["poetry-core>=1.0.0", "Cython>=0.29.32"]
+build-backend = "poetry.core.masonry.api"

setup.cfg

@@ -1,3 +0,0 @@
-# https://github.com/embray/setup.cfg
-[metadata]
-license_file = LICENSE

setup.py

@@ -1,101 +0,0 @@
-"""A setuptools based setup module.
-
-See:
-https://packaging.python.org/en/latest/distributing.html
-https://github.com/pypa/sampleproject
-
-Steps for deploying a new version:
-1. Increase the version number
-2. remove the old deployment under [dist] and [build] folder
-3. run: python setup.py sdist
-4. twine upload dist/*
-"""
-
-import sys
-
-# Always prefer setuptools over distutils
-from setuptools import setup, find_packages
-
-# To use a consistent encoding
-from codecs import open
-from os import path
-
-here = path.abspath(path.dirname(__file__))
-
-# Get the long description from the README file
-with open(path.join(here, "README.rst"), encoding="utf-8") as f:
-    long_description = f.read()
-
-
-details = dict(
-    name="pyModeS",
-    version="2.11",
-    description="Python Mode-S and ADS-B Decoder",
-    long_description=long_description,
-    url="https://github.com/junzis/pyModeS",
-    author="Junzi Sun",
-    author_email="j.sun-1@tudelft.nl",
-    license="GNU GPL v3",
-    classifiers=[
-        "Development Status :: 4 - Beta",
-        "Intended Audience :: Developers",
-        "Topic :: Software Development :: Libraries",
-        "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
-        "Programming Language :: Python :: 3",
-    ],
-    keywords="Mode-S ADS-B EHS ELS Comm-B",
-    packages=find_packages(exclude=["contrib", "docs", "tests"]),
-    # typing_extensions are no longer necessary after Python 3.8 (TypedDict)
-    install_requires=["numpy", "pyzmq", "typing_extensions"],
-    extras_require={"fast": ["Cython"]},
-    package_data={
-        "pyModeS": ["*.pyx", "*.pxd", "py.typed"],
-        "pyModeS.decoder.flarm": ["*.pyx", "*.pxd", "*.pyi"],
-    },
-    scripts=["pyModeS/streamer/modeslive"],
-)
-
-try:
-    from distutils.core import Extension
-    from Cython.Build import cythonize
-
-    compile_args = []
-    include_dirs = ["pyModeS/decoder/flarm"]
-
-    if sys.platform == "linux":
-        compile_args += [
-            "-march=native",
-            "-O3",
-            "-msse",
-            "-msse2",
-            "-mfma",
-            "-mfpmath=sse",
-            "-Wno-pointer-sign",
-        ]
-
-    extensions = [
-        Extension("pyModeS.c_common", ["pyModeS/c_common.pyx"]),
-        Extension(
-            "pyModeS.decoder.flarm.decode",
-            [
-                "pyModeS/decoder/flarm/decode.pyx",
-                "pyModeS/decoder/flarm/core.c",
-            ],
-            extra_compile_args=compile_args,
-            include_dirs=include_dirs,
-        ),
-    ]
-
-    setup(
-        **dict(
-            details,
-            ext_modules=cythonize(
-                extensions,
-                include_path=include_dirs,
-                compiler_directives={"binding": True, "language_level": 3},
-            ),
-        )
-    )
-
-except ImportError:
-    setup(**details)