Merge pull request #14 from Princeton-CDH/chore/10-gh-actions

Migrate from Tox to Github actions; add missing unit tests to pytest scope (#10)

Author: blms

.codeclimate.yml

@@ -1,7 +1,6 @@
 [run]
 source = neuxml
-
-[report]
 omit =
-    */python?.?/*
-    */site-packages/nose/*
+    # omit generated PLY files from coverage
+    lextab.py
+    parsetab.py

.coveragerc

@@ -0,0 +1,51 @@
+name: unit tests
+
+on:
+  push: # run on every push or PR to any branch
+  pull_request:
+  schedule: # run automatically on main branch each Tuesday at 11am
+    - cron: "0 16 * * 2"
+
+jobs:
+  python-unit:
+    name: Python unit tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+
+      # We base the python cache on the hash of all requirements files, so that
+      # if any change, the cache is invalidated.
+      - name: Cache pip
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: pip-${{ hashFiles('pyproject.toml') }}
+          restore-keys: |
+            pip-${{ hashFiles('pyproject.toml') }}
+            pip-
+
+      - name: Install package with dependencies
+        run: |
+          pip install -e '.[dev]'
+          pip install codecov
+
+      - name: Generate PLY lextab and parsetab artifacts
+        run: python -c "import neuxml.xpath.core"
+
+      - name: Run pytest
+        run: pytest --cov=neuxml --cov-report=xml
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          slug: Princeton-CDH/neuxml

.github/workflows/unit_tests.yml

@@ -26,7 +26,7 @@ To run all unit tests::
     pytest
 
     # for continuous integration
-    pytest --cov=./ --cov-report=xml
+    pytest --cov=neuxml --cov-report=xml
 
 To run unit tests for a specific module, use syntax like this::
 

.travis.yml

@@ -4,7 +4,7 @@ Migration from ``eulxml``
 A convenience script called ``migrate-eulxml`` has been included in order
 to migrate your project from ``eulxml`` to ``neuxml``, which will replace
 any usage of the package name in all ``.py`` files in the passed directory
-and subdirectories. After upgrading to Python 3.12+ and installing the
+and subdirectories. After upgrading to Python 3.10+ and installing the
 updated package, you can run the script::
 
     migrate-eulxml /path/to/your/project

DEVNOTES.rst

@@ -22,7 +22,6 @@
     # 'logo': 'logo.png',
     "github_user": "Princeton-CDH",
     "github_repo": "neuxml",
-    # 'travis_button': True,  # enable when we get travis-ci set up
     "description": "Python library to read and write structured XML",
     # 'analytics_id':
 }

MIGRATION.rst

@@ -8,7 +8,7 @@ description = "XPath-based XML data binding"
 authors = [
     { name = "Center for Digital Humanities at Princeton", email = "cdhdevteam@princeton.edu" },
 ]
-requires-python = ">=3.12"
+requires-python = ">=3.10"
 readme = "README.rst"
 license = { text = "Apache-2" }
 dynamic = ["version"]
@@ -19,7 +19,10 @@ classifiers = [
     "Natural Language :: English",
     "Operating System :: OS Independent",
     "Programming Language :: Python",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "Topic :: Software Development :: Libraries :: Python Modules",
     "Topic :: Text Processing :: Markup :: XML",
 ]
@@ -32,7 +35,6 @@ dev = [
     "pytest>=4.6",
     "pytest-cov",
     "pytest-socket",
-    "tox",
     "requests",
     "pre-commit",
 ]

doc/conf.py

@@ -1,2 +1,2 @@
 [pytest]
-python_files = "test/**/*.py"
+python_files = "test/**.py"