Replace Makefile with poethepoet (#69)

Author: shapiromatron

.github/workflows/main.yml

@@ -1,31 +1,59 @@
 name: CI
 
-on: [ pull_request ]
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+    tags:
+      - '*'
+  workflow_dispatch:
 
 jobs:
 
-  backend:
-    name: lint + test
+  test:
+    name: test
     runs-on: ubuntu-latest
-
     strategy:
-      max-parallel: 4
+      max-parallel: 5
       matrix:
         python-version: [ "3.9", "3.10", "3.11", "3.12" , "3.13" ]
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+      with:
+        enable-cache: true
+        cache-dependency-glob: "**/pyproject.toml"
+    - name: Install dependencies
+      run: uv sync --all-extras
+    - name: Test with pytest
+      run: uv run poe test
 
+  coverage:
+    name: test + lint + coverage
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v3
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: install
-        run: |
-          python -m pip install -U pip
-          pip install -e ".[dev]"
-      - name: lint
-        run: |
-          make lint
-      - name: test
-        run: |
-          make coverage
-          coverage report
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+      with:
+        python-version: "3.13"
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+      with:
+        enable-cache: true
+        cache-dependency-glob: "**/pyproject.toml"
+    - name: Install dependencies
+      run: uv sync --all-extras
+    - name: Check linting
+      run: uv run poe lint
+    - name: Test with pytest
+      run: uv run coverage run -m pytest --benchmark-skip
+    - name: Generate coverage report
+      run: |
+        echo "# Coverage Report" >> $GITHUB_STEP_SUMMARY
+        uv run coverage report --format=markdown >> $GITHUB_STEP_SUMMARY || true
+        uv run coverage json -q  # will cause pipeline failure if coverage < minimum

.gitignore

@@ -6,6 +6,7 @@
 *.mo
 *.nja
 *.py[co]
+.benchmarks
 .cache
 .coverage
 .idea
@@ -19,7 +20,7 @@
 /.project
 /.pydevproject
 build
-coverage_html
+htmlcov
 dist
 venv
 

Makefile

@@ -91,7 +91,7 @@ Writing:
 
 ## TAG_KEY_MAPPING
 
-Most fields contain string values, but some like first_authors (A1) are parsed into lists. The default mapping is 
+Most fields contain string values, but some like first_authors (A1) are parsed into lists. The default mapping is
 created from specifications scattered around the web, but to our knowledge there is not one single source of RIS truth,
 so these may need to be modified for specific export systems:
 
@@ -314,24 +314,31 @@ support. Software specializing in these formats includes:
 
 ## Developer instructions
 
-Common developer commands are in the provided `Makefile`; if you don't have `make` installed, you can view the make
-commands and run the commands from the command-line manually:
+Install [uv](https://docs.astral.sh/uv/) and make it available and on your path. Then:
 
 ```bash
 # setup environment
-python -m venv venv
-source venv/bin/activate
-python -m pip install -U pip
-python -m pip install -e ".[dev]"
+uv venv --python=3.13
+source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+uv pip install -e ".[dev]"
+
+# list available tasks
+poe
 
 # check if code format changes are required
-make lint
+poe lint
 
 # reformat code
-make format
+poe format
 
 # run tests
-make test
+poe test
+
+# run benchmark tests
+poe bench
 ```
 
+If you'd prefer not to use `uv`, that's fine too; this is a standard Python package so feel free to use your
+preferred workflow.
+
 Github Actions are currently enabled to run `lint` and `test` when submitting a pull-request.

README.md

@@ -30,6 +30,7 @@ requires-python = ">=3.9"
 
 [project.optional-dependencies]
 dev = [
+    "poethepoet ~= 0.34.0",
     "pytest ~=7.4.4",
     "pytest-benchmark",
     "flit ~= 3.9.0",
@@ -46,8 +47,12 @@ omit = [
     "tests/*",
 ]
 
+[tool.coverage.report]
+fail_under=94
+precision=1
+
 [tool.flit.sdist]
-exclude = [".github", "Makefile", "tests"]
+exclude = [".github", "tests"]
 
 [tool.ruff]
 line-length = 100
@@ -61,3 +66,36 @@ select = ["F", "E", "W", "I", "UP", "S", "B", "T20", "RUF"]
 
 [tool.pytest.ini_options]
 addopts = "--doctest-glob='*.md'"
+
+[tool.poe.tasks.lint]
+help = "Check for formatting issues"
+sequence = [
+  {cmd = "ruff format . --check"},
+  {cmd = "ruff check ."},
+]
+
+[tool.poe.tasks.format]
+help = "Fix formatting issues (where possible)"
+sequence = [
+  {cmd = "ruff format ."},
+  {cmd = "ruff check . --fix --show-fixes"},
+]
+
+[tool.poe.tasks.test]
+help = "Run tests"
+cmd = "pytest --benchmark-skip"
+
+[tool.poe.tasks.bench]
+help = "Run benchmark tests"
+cmd = "pytest --benchmark-only"
+
+[tool.poe.tasks.coverage]
+help = "Generate test coverage report"
+sequence = [
+  {cmd = "coverage run -m pytest --benchmark-skip"},
+  {cmd = "coverage html"},
+]
+
+[tool.poe.tasks.build]
+help = "Build wheel package"
+cmd = "uv build"