Update CI build and requirements (#61)

Updates the build and project structure into a src patterned project and
fixes up dependencies and other stale CI configurations to get it
working today.

Author: jborean93

.github/workflows/ci.yml

@@ -21,8 +21,29 @@ on:
     - published
 
 jobs:
+  build:
+    name: build
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Check out code
+      uses: actions/checkout@v5
+
+    - name: Build pypsexec
+      run: |
+        python -m pip install build
+        python -m build
+
+    - name: Upload built pypsexec
+      uses: actions/upload-artifact@v4
+      with:
+        name: artifact
+        path: ./dist/*
+
   test:
     name: test
+    needs:
+    - build
     runs-on: ${{ matrix.os }}
 
     strategy:
@@ -32,11 +53,12 @@ jobs:
         - ubuntu-latest
         - windows-latest
         python-version:
-        - 3.7
-        - 3.8
         - 3.9
         - '3.10'
         - '3.11'
+        - '3.12'
+        - '3.13'
+        - '3.14'
         python-arch:
         - x86
         - x64
@@ -46,17 +68,23 @@ jobs:
           python-arch: x86
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v5
 
-    - uses: actions/setup-python@v4
+    - uses: actions/setup-python@v6
       with:
         python-version: ${{ matrix.python-version }}
         architecture: ${{ matrix.python-arch }}
 
+    - uses: actions/download-artifact@v5
+      with:
+        name: artifact
+        path: ./dist
+
     - name: Extract OS name
       shell: bash
       run: |
         echo NAME=$( echo '${{ matrix.os }}' | tr '-' ' ' | awk '{print $1}' )
+        echo "${NAME}"
         echo "name=${NAME}" >> $GITHUB_OUTPUT
       id: os
 
@@ -73,24 +101,25 @@ jobs:
 
     - name: Upload Test Results
       if: always()
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: Unit Test Results (${{ matrix.os }} ${{ matrix.python-version }} ${{ matrix.python-arch }})
         path: ./junit/test-results.xml
 
     - name: Upload Coverage Results
       if: always()
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: Coverage Results (${{ matrix.os }} ${{ matrix.python-version }} ${{ matrix.python-arch }})
         path: ./coverage.xml
 
     - name: Upload Coverage to codecov
       if: always()
-      uses: codecov/codecov-action@v3
+      uses: codecov/codecov-action@v5
       with:
         files: ./coverage.xml
         flags: ${{ steps.os.outputs.name }},py${{ matrix.python-version }},${{ matrix.python-arch }}
+        token: ${{ secrets.CODECOV_TOKEN }}
 
   publish:
     name: publish
@@ -102,20 +131,11 @@ jobs:
       id-token: write
 
     steps:
-    - uses: actions/checkout@v3
-
-    - name: Installing baseline packages
-      run: python -m pip install --upgrade pip setuptools wheel
-
-    - name: Build package
-      run: python setup.py sdist bdist_wheel
-
-    - name: Capture Wheel and SDist
-      uses: actions/upload-artifact@v3
+    - uses: actions/download-artifact@v5
       with:
         name: artifact
-        path: dist/*
+        path: ./dist
 
     - name: Publish
-      if: startsWith(github.ref, 'refs/tags/v')
+      if: startsWith(github.event.release.tag_name, 'v')
       uses: pypa/gh-action-pypi-publish@release/v1

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## 0.4.0 - TBD
 
-* Dropped Python 3.6, new minimum is 3.7
+* Dropped old Python versions, new minimum is 3.9
 
 ## 0.3.0 - 2021-10-22
 

MANIFEST.in

@@ -1,3 +1,3 @@
 include LICENSE
 include CHANGELOG.md
-include pypsexec/paexec.exe
+include src/pypsexec/paexec.exe

README.md

@@ -78,7 +78,7 @@ decoded by someone who knows the protocol.
 
 ## Requirements
 
-* Python 3.7+
+* Python 3.9+
 * [smbprotocol](https://github.com/jborean93/smbprotocol)
 
 To install pypsexec, simply run
@@ -353,18 +353,12 @@ by running;
 
 ```bash
 pip install -r requirements-test.txt
-
-# you can also run tox by installing tox
-pip install tox
 ```
 
 From there to run the basic tests run;
 
 ```bash
-py.test -v --cov pypsexec --cov-report term-missing
-
-# or with tox
-tox
+python -m pytest -v --cov pypsexec --cov-report term-missing
 ```
 
 There are extra tests that only run when certain environment variables are set.
@@ -374,7 +368,7 @@ To run these tests set the following variables;
 * `PYPSEXEC_USERNAME`: The username to use authenticate with
 * `PYPSEXEC_PASSWORD`: The password for `PYPSEXEC_USERNAME`
 
-From there, you can just run `tox` or `py.test` with these environment
+From there, you can just run `pytest` with these environment
 variables to run the integration tests.
 
 

build_helpers/lib.sh

@@ -41,14 +41,17 @@ lib::setup::python_requirements() {
         echo "::group::Installing Python Requirements"
     fi
 
-    echo "Upgrading baseline packages"
-    python -m pip install --upgrade pip setuptools wheel
-
     echo "Installing pypsexec"
-    python -m pip install .
+    # Getting the version is important so that pip prioritises our local dist
+    python -m pip install build
+    PACKAGE_VERSION="$( python -c "import build.util; print(build.util.project_wheel_metadata('.').get('Version'))" )"
+
+    python -m pip install pypsexec=="${PACKAGE_VERSION}" \
+        --find-links ./dist \
+        --verbose
 
-    echo "Install test requirements"
-    python -m pip install -r requirements-test.txt
+    echo "Installing dev dependencies"
+    python -m pip install -r requirements-dev.txt
 
     if [ x"${GITHUB_ACTIONS}" = "xtrue" ]; then
         echo "::endgroup::"
@@ -60,12 +63,6 @@ lib::sanity::run() {
         echo "::group::Running Sanity Checks"
     fi
 
-    python -m pycodestyle \
-        pypsexec \
-        --verbose \
-        --show-source \
-        --statistics
-
     if [ x"${GITHUB_ACTIONS}" = "xtrue" ]; then
         echo "::endgroup::"
     fi

pyproject.toml

@@ -0,0 +1,40 @@
+[build-system]
+requires = [
+    "setuptools >= 77.0.0",  # Support for SPDX license expressions
+]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pypsexec"
+version = "0.4.0"
+description = "Run commands on a remote Windows host using SMB/RPC"
+readme = "README.md"
+requires-python = ">=3.9"
+license = "MIT"
+authors = [
+    { name = "Jordan Borean", email = "jborean93@gmail.com" }
+]
+keywords = ["windows", "psexec", "paexec", "remote", "python"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+dependencies = [
+    "smbprotocol",
+]
+
+[project.urls]
+homepage = "https://github.com/jborean93/pypsexec"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = "tests"
+addopts = "--import-mode=importlib"

requirements-test.txt requirements-dev.txtrequirements-test.txt renamed to requirements-dev.txt

@@ -1,4 +1,4 @@
-pycodestyle
+build
 pytest
 pytest-cov
 pytest-mock