Add GitHub workflows for linting, testing, building, and publishing (y-scope#32)

davidlion · web-flow · commit 8fbc5f49e577 · 2023-07-13T02:55:56.000-04:00
diff --git a/.github/workflows/package.yaml b/.github/workflows/package.yaml
@@ -0,0 +1,90 @@
+name: Lint, build, and test package
+
+on:
+  pull_request:
+  push:
+  workflow_call:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.11"]
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - run: pip install --upgrade
+          pip
+          .[dev]
+
+      - run: docformatter --check --diff src tests
+
+      - run: black --diff --check src/ tests/
+
+      - run: ruff check --format=github src/ tests/
+
+      - run: mypy src/ tests/
+
+      - run: python -m build
+
+      - uses: actions/upload-artifact@v3
+        with:
+          name: wheel-${{ matrix.python-version }}
+          path: dist/*
+          retention-days: 1
+
+  test:
+    needs: [build]
+    strategy:
+      matrix:
+        os: [macos-latest, ubuntu-latest]
+        python-version: ["3.8", "3.11"]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - uses: actions/download-artifact@v3
+        with:
+          name: wheel-${{ matrix.python-version }}
+          path: dist/
+
+      - run: pip install --upgrade
+          pip
+          dist/clp_logging-*.whl
+          -r requirements-test.txt
+
+      - run: python -m unittest -fv
+
+  test-py36:
+    needs: [build]
+    strategy:
+      matrix:
+        os: [macos-latest, ubuntu-20.04]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.6"
+
+      - uses: actions/download-artifact@v3
+        with:
+          name: wheel-3.8
+          path: dist/
+
+      - run: pip install --upgrade
+          pip
+          dist/clp_logging-*.whl
+          -r requirements-test.txt
+
+      - run: python -m unittest -fv
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -0,0 +1,39 @@
+name: Upload package to PyPI
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  package:
+    uses: ./.github/workflows/package.yaml
+
+  # https://docs.pypi.org/trusted-publishers/using-a-publisher/
+  pypi-publish:
+    needs: [package]
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.8"
+
+      - uses: actions/download-artifact@v3
+        with:
+          name: wheel-3.8
+          path: dist/
+
+      - name: Publish to test.pypi.org
+        if: ${{ 'y-scope' != github.repository_owner }}
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+      - name: Publish to pypi.org
+        if: ${{ 'y-scope' == github.repository_owner }}
+        uses: pypa/gh-action-pypi-publish@release/v1
diff --git a/README.md b/README.md
@@ -198,33 +198,34 @@ logging.getLogger(__name__).addHandler(clp_handler)
 
 ## Compatibility
 
-Tested on Python 3.6 and 3.8 and should work on any newer version.
+Tested on Python 3.6, 3.8, and 3.11 (should also work on newer versions).
 Built/packaged on Python 3.8 for convenience regarding type annotation.
 
-## Building/Packaging
+## Development
+
+### Setup environment
 
 1. Create and enter a virtual environment:
    `python3.8 -m venv venv; . ./venv/bin/activate`
-2. Install development dependencies:
-   `pip install -r requirements-dev.txt`
-3. Build:
+2. Install the project in editable mode, the development dependencies, and the test dependencies:
+   `pip install -e .[dev,test]`
+
+Note: you may need to upgrade pip first for `-e` to work. If so, run: `pip install --upgrade pip`
+
+### Packaging
+
+To build a package for distribution run:
    `python -m build`
 
-## Testing
+### Testing
 
-Note the baseline comparison logging handler and the CLP handler both get
+To run the unit tests run:
+   `python -m unittest -bv`
+
+Note: the baseline comparison logging handler and the CLP handler both get
 unique timestamps. It is possible for these timestamps to differ, which will
 result in a test reporting a false positive error.
 
-1. Create and enter a virtual environment:
-   `python -m venv venv; .  ./venv/bin/activate`
-2. Install development dependencies:
-   `pip install -r requirements-dev.txt`
-3. Install:
-   `pip install dist/clp_logging-*-py3-none-any.whl` or `pip install -e .`
-4. Run unittest:
-   `python -m unittest -bv`
-
 ## Contributing
 
 Before submitting a pull request, run the following error-checking and
@@ -239,6 +240,9 @@ formatting tools (found in [requirements-dev.txt](requirements-dev.txt)):
 * [Black][6]: `black src tests`
   * This formats the code according to Black's code-style rules. You should
     review and add any changes to your PR.
+* [ruff][8]: `ruff check --fix src tests`
+  * This performs linting according to PEPs. You should review and add any
+    changes to your PR.
 
 Note that `docformatter` should be run before `black` to give Black the [last
 word][7].
@@ -251,3 +255,4 @@ word][7].
 [5]: https://docformatter.readthedocs.io/en/latest/
 [6]: https://black.readthedocs.io/en/stable/index.html
 [7]: https://docformatter.readthedocs.io/en/latest/faq.html#interaction-with-black
+[8]: https://beta.ruff.rs/docs/
diff --git a/pyproject.toml b/pyproject.toml
@@ -14,23 +14,35 @@ readme = "README.md"
 requires-python = ">=3.6"
 dependencies = [
     "python-dateutil >= 2.7.0",
-    "smart_open >= 6.3.0",
     "typing-extensions >= 3.7.4",
     "zstandard >= 0.18.0",
 ]
 classifiers = [
 "License :: OSI Approved :: Apache Software License",
 ]
 
+[project.optional-dependencies]
+dev = [
+    "black >= 22.10.0",
+    "build >= 0.8.0",
+    "docformatter >= 1.5.1",
+    "mypy >= 0.982",
+    "ruff >= 0.0.275",
+    "types-python-dateutil >= 2.8.19.2",
+]
+test = [
+    "smart_open >= 6.3.0",
+]
+
 [project.urls]
 "Homepage" = "https://github.com/y-scope/clp-loglib-py"
 "Bug Tracker" = "https://github.com/y-scope/clp-loglib-py/issues"
 
-[tool.setuptools_scm]
-
-[tool.mypy]
-strict = true
-pretty = true
+[tool.black]
+line-length = 100
+target-version = ["py311"]
+color = true
+preview = true
 
 [tool.docformatter]
 make-summary-multi-line = true
@@ -39,8 +51,12 @@ recursive = true
 wrap-summaries = 80
 wrap-descriptions = 80
 
-[tool.black]
+[tool.mypy]
+strict = true
+pretty = true
+
+[tool.ruff]
 line-length = 100
-target-version = ["py311"]
-color = true
-preview = true
+src = ["src"]
+
+[tool.setuptools_scm]
diff --git a/requirements-dev.txt b/requirements-dev.txt
diff --git a/requirements-test.txt b/requirements-test.txt
@@ -0,0 +1 @@
+smart_open>=6.3.0
diff --git a/src/clp_logging/decoder.py b/src/clp_logging/decoder.py
@@ -1,5 +1,5 @@
 import json
-from typing import Dict, Optional, Tuple
+from typing import Optional, Tuple
 
 from clp_logging.protocol import (
     BYTE_ORDER,
diff --git a/src/clp_logging/encoder.py b/src/clp_logging/encoder.py
@@ -2,7 +2,7 @@
 from math import floor
 import re
 import time
-from typing import Dict, Match, Pattern
+from typing import Match, Pattern
 
 from clp_logging.protocol import (
     BYTE_ORDER,
@@ -72,11 +72,11 @@ def emit_preamble(timestamp: int, timestamp_format: str, timezone: str) -> bytea
         Create the encoded CLP preamble for a stream of encoded log messages.
 
         :param timestamp: Reference timestamp used to calculate deltas emitted
-        with each message.
+            with each message.
         :param timestamp_format: Timestamp format to be use when generating the
-        logs with a reader.
+            logs with a reader.
         :param timezone: Timezone in TZID format to be use when generating the
-        timestamp from Unix epoch time.
+            timestamp from Unix epoch time.
         :raises NotImplementedError: If metadata length too large
         :return: The encoded preamble
         """
@@ -233,7 +233,7 @@ def emit_token(token_m: Match[bytes], clp_msg: bytearray) -> bytes:
         Encode `token_m` appending it to `clp_msg` if it is a variable.
 
         :return: If the token was a variable returns the delimiter to append to
-        logtype, otherwise returns the static text to append to the logtype.
+            logtype, otherwise returns the static text to append to the logtype.
         """
         token: bytes = token_m.group(0)
 
diff --git a/src/clp_logging/handlers.py b/src/clp_logging/handlers.py
diff --git a/tests/test_handlers.py b/tests/test_handlers.py
