Merge pull request #75 from oresat/packaging-improvements

Use more modern python packaging conventions

Author: ThirteenFish

.github/workflows/pypi.yaml

@@ -2,20 +2,20 @@ name: Upload Python Package
 
 on:
   release:
-    types: [published]
+    types: [ "published" ]
 
 jobs:
   deploy:
-
     runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
 
     steps:
-    - uses: actions/checkout@v3
-
-    - name: Set up Python
-      uses: actions/setup-python@v3
+    - uses: actions/checkout@v6
+    - uses: actions/setup-python@v6
       with:
-        python-version: '3.x'
+        python-version: "3.9"
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
@@ -24,9 +24,5 @@ jobs:
     - name: Build package
       run: python -m build
 
-    - name: Publish package
-      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
-      with:
-        user: __token__
-        password: ${{ secrets.PYPI_API_TOKEN }}
-
+    - name: Publish
+      uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/tests.yaml

@@ -26,19 +26,19 @@ jobs:
       id: dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -r requirements.txt
+        pip install . --group dev
 
     # - name: Lint with Pylama
     #  if: always() && steps.dependencies.conclusion == 'success'
     #  run: pylama
 
-    - name: Check format with Black
+    - name: Lint with Ruff
       if: always() && steps.dependencies.conclusion == 'success'
-      run: black --check --diff .
+      run: ruff check --select=E,F,I
 
-    - name: Check format with isort
+    - name: Check format with Ruff
       if: always() && steps.dependencies.conclusion == 'success'
-      run: isort --check --diff .
+      run: ruff format --check --diff
 
     - name: Test with Python's unittest
       if: always() && steps.dependencies.conclusion == 'success'

README.md

@@ -20,12 +20,13 @@ Framework), which it built on top of [CANopen for Python] project. See the
 
 **For development**, install `oresat-configs` from the GitHub repo at
 https://github.com/oresat/oresat-configs (not from PyPI). That repo may have
-changes that are not apart of the latest release yet.
+changes that are not apart of the latest release yet. Cloning it and using
+`pip install --editable <path to your oresat-configs repo>` is very convenient.
 
 Install dependencies
 
 ```bash
-$ pip3 install -r requirements.txt
+$ pip3 install -e . --group dev
 ```
 
 Make a virtual CAN bus (skip if using a real CAN bus)

oresat_c3/__init__.py

@@ -1,6 +1,6 @@
 """C3 OLAF App."""
 
-from enum import Enum, IntEnum
+from enum import IntEnum
 
 try:
     from ._version import version as __version__  # type: ignore

oresat_c3/drivers/fm24cl64b.py

@@ -38,8 +38,7 @@ def __init__(self, bus_num: int, addr: int, mock: bool = False):
 
         if addr not in self.ADDRESSES:
             raise Fm24cl64bError(
-                f"arg addr 0x{addr:X} is not between 0x{self.ADDR_MIN:X} "
-                f"and 0x{self.ADDR_MAX:X}"
+                f"arg addr 0x{addr:X} is not between 0x{self.ADDR_MIN:X} and 0x{self.ADDR_MAX:X}"
             )
 
         self._bus_num = bus_num

oresat_c3/protocols/edl_packet.py

@@ -9,19 +9,8 @@
 
 from spacepackets.cfdp.pdu import PduFactory
 from spacepackets.cfdp.pdu.file_directive import AbstractPduBase
-from spacepackets.uslp.frame import (  # type: ignore
-    FrameType,
-    TfdzConstructionRules,
-    TransferFrame,
-    TransferFrameDataField,
-    UslpProtocolIdentifier,
-)
-from spacepackets.uslp.header import (  # type: ignore
-    BypassSequenceControlFlag,
-    PrimaryHeader,
-    ProtocolCommandFlag,
-    SourceOrDestField,
-)
+from spacepackets.uslp.frame import FrameType, TransferFrame
+from spacepackets.uslp.header import SourceOrDestField
 
 from .edl_command import EdlCommandCode, EdlCommandError, EdlCommandRequest, EdlCommandResponse
 from .uslp import HMAC_LEN, SEQ_NUM_LEN, make_frame

oresat_c3/subsystems/opd.py

@@ -597,7 +597,6 @@ def uart_node(self) -> Union[str, None]:
 
     @uart_node.setter
     def uart_node(self, name: Union[str, None]) -> None:
-
         self._uart_disconnect()
         if name is None or self._nodes[name].status == OpdNodeState.NOT_FOUND:
             return

pyproject.toml

@@ -16,18 +16,29 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Topic :: Software Development :: Embedded Systems",
 ]
+dynamic = ["version"]
+
 dependencies = [
     "bitstring",
     "cfdp-py~=0.6.0",
     "dataclasses-json",
     "fastcrc~=0.3",
-    "oresat-configs==0.8.*",
-    "oresat-olaf>=3.6.5",
+    "oresat-configs>=1.1.1",
+    "oresat-olaf>=3.7.1",
     "smbus2",
     "spacepackets>=0.30.1",
     "ccsds-cop>=0.0.0",
 ]
-dynamic = ["version"]
+
+[dependency-groups]
+dev = [
+    "build",
+    "pylama[all,toml]",
+    "ruff",
+    "sphinx",
+    "sphinx-rtd-theme",
+    "sphinxcontrib-mermaid",
+]
 
 [project.scripts]
 oresat-c3 = "oresat_c3.__main__:main"
@@ -41,8 +52,11 @@ exclude = ["docs*", "tests*", "scripts*"]
 [tool.setuptools_scm]
 write_to = "oresat_c3/_version.py"
 
-[tool.black]
-line_length = 100
+[tool.ruff]
+line-length = 100
+
+[tool.ruff.format]
+quote-style = "preserve"
 
 [tool.pylama]
 format = "pylint"
@@ -87,7 +101,3 @@ ignore = "W0212"
 [[tool.mypy.overrides]]
 module = "canopen,olaf,oresat_configs,spacepackets"
 ignore_missing_imports = true
-
-[tool.isort]
-profile = "black"
-line_length = 100

requirements.txt

@@ -1,7 +1,6 @@
 #!/usr/bin/env python3
 """Listens for and prints C3 beacons"""
 
-
 import os
 import socket
 import sys