Replace tox with pytest and Makefile, cleanup in docs/Makefile (#669)

* Remove unused code from docs Makefile

* Fix missing backtick in docstring

* Remove tox

* Add programmatic year setting in docs

* Move python version string to env, use dependency groups in pre-release.yml

* Sync pre-release.yml to release.yml

* Add "Python 3 Only" classifier

* Update missed deps installation statement in test.yml

* Run linter on CHANGELOG.md, fix typos

* Capitalize some terms in CHANGELOG

* Add unfortunate workaround for deps installation in Python 3.7 in CI

* Unify naming in GH Action workflows

* Fix missing dependencies in test suite 🤦

* Use latest release of splunk-app-collection

* Separate .PHONY-ies as they look better; Update README.md

* uv.lock

* More cleanup in `Makefile`s

* Fix "Converting `source_suffix = '.rst'` to `source_suffix = {'.rst': 'restructuredtext'}`."

* Refactor README

* Refactor README #2

* Finish cleanup in Makefile

* Spruce up example app names etc.

* Separate app dependency install for Python 3.7 and the rest

* Rewrite installation section in README

* Drop `deprecation` from dependencies in test.yml

* PR review changes

* Another README refactor

* Run `mbake` on `Makefile`s

* Pin dependencies in `pyproject.toml` wherever possible

* Adjust details in README

* Retires -> retries

* Last adjustments to README

* Adjust docstring in client.py

* PR review adjustments

Author: Ickerday

.coveragerc

@@ -1,4 +1,3 @@
 [run]
 omit =
-    .tox/*
     tests/*

.github/workflows/pre-release.yml

@@ -1,9 +1,11 @@
-name: CD
+name: Publish SDK to Test PyPI
 on: [workflow_dispatch]
 
+env:
+  PYTHON_VERSION: 3.9
+
 jobs:
-  test-pypi-deploy:
-    name: Deploy to Test PyPI
+  publish-sdk-test-pypi:
     runs-on: ubuntu-latest
     permissions:
       id-token: write
@@ -12,15 +14,15 @@ jobs:
     steps:
       - name: Checkout source
         uses: actions/checkout@ff7abcd0c3c05ccf6adc123a8cd1fd4fb30fb493
-      - name: Set up Python
+      - name: Set up Python ${{ env.PYTHON_VERSION }}
         uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c
         with:
-          python-version: 3.9
+          python-version: ${{ env.PYTHON_VERSION }}
       - name: Install dependencies
-        run: pip install build
-      - name: Build package
+        run: python -m pip install . --group build
+      - name: Build packages for distribution
         run: python -m build
-      - name: Publish package to Test PyPI
+      - name: Publish packages to Test PyPI
         uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e
         with:
           repository-url: https://test.pypi.org/legacy/

.github/workflows/release.yml

@@ -1,11 +1,13 @@
-name: Release
+name: Publish SDK to PyPI
 on:
   release:
     types: [published]
 
+env:
+  PYTHON_VERSION: 3.9
+
 jobs:
-  publish:
-    name: Deploy release to PyPI
+  publish-sdk-pypi:
     runs-on: ubuntu-latest
     permissions:
       id-token: write
@@ -14,24 +16,20 @@ jobs:
     steps:
       - name: Checkout source
         uses: actions/checkout@ff7abcd0c3c05ccf6adc123a8cd1fd4fb30fb493
-      - name: Set up Python
+      - name: Set up Python ${{ env.PYTHON_VERSION }}
         uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c
         with:
-          python-version: 3.9
+          python-version: ${{ env.PYTHON_VERSION }}
       - name: Install dependencies
-        run: pip install build
-      - name: Build package
+        run: python -m pip install . --group release
+      - name: Build packages for distribution
         run: python -m build
-      - name: Publish package to PyPI
+      - name: Publish packages to PyPI
         uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e
-      - name: Install tox
-        run: pip install tox
-      - name: Generate API docs
-        run: |
-          rm -rf ./docs/_build
-          tox -e docs
-      - name: Docs Upload
+      - name: Generate API reference
+        run: make -C ./docs html
+      - name: Upload docs artifact
         uses: actions/upload-artifact@de65e23aa2b7e23d713bb51fbfcb6d502f8667d8
         with:
-          name: python_sdk_docs
+          name: python-sdk-docs
           path: docs/_build/html

.github/workflows/test.yml

@@ -2,7 +2,7 @@ name: Python CI
 on: [push, workflow_dispatch]
 
 jobs:
-  build:
+  run-test-suite:
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
@@ -23,13 +23,17 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@ff7abcd0c3c05ccf6adc123a8cd1fd4fb30fb493
-      - name: Run docker compose
+      - name: Launch Splunk Docker instance
         run: SPLUNK_VERSION=${{ matrix.splunk-version }} docker compose up -d
-      - name: Setup Python
+      - name: Setup Python ${{ matrix.python-version }}
         uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Install tox
-        run: pip install tox
-      - name: Test Execution
-        run: tox -e py -- ./tests
+      - name: (Python 3.7) Install dependencies
+        if: ${{ matrix.python-version == '3.7' }}
+        run: python -m pip install python-dotenv pytest
+      - name: (Python >= 3.9) Install dependencies
+        if: ${{ matrix.python-version != '3.7' }}
+        run: python -m pip install . --group test
+      - name: Run entire test suite
+        run: python -m pytest ./tests

CHANGELOG.md

@@ -1,56 +1,48 @@
-RESET_COLOR=\033[0m
-GREEN_COLOR=\033[32;01m
-
-CONTAINER_NAME := 'splunk'
+CONTAINER_NAME := "splunk"
 
 .PHONY: docs
 docs:
-	@echo "$(GREEN_COLOR)==> docs $(RESET_COLOR)"
-	@rm -rf ./docs/_build
-	@tox -e docs
-	@cd ./docs/_build/html && zip -r ../docs_html.zip . -x ".*" -x "__MACOSX"
-	@echo "$(ATTN_COLOR)==> Docs pages can be found at ./docs/_build/html, docs bundle available at ./docs/_build/docs_html.zip"
+	@make -C ./docs html
 
 .PHONY: test
 test:
-	@echo "$(GREEN_COLOR)==> test $(RESET_COLOR)"
-	@tox -e py -- ./tests
+	@python -m pytest ./tests
 
 .PHONY: test-unit
-test:
-	@echo "$(GREEN_COLOR)==> test $(RESET_COLOR)"
-	@tox -e py -- ./tests/unit
+test-unit:
+	@python -m pytest ./tests/unit
 
 .PHONY: test-integration
-test:
-	@echo "$(GREEN_COLOR)==> test $(RESET_COLOR)"
-	@tox -e py -- ./tests/integration ./tests/system
+test-integration:
+	@python -m pytest ./tests/integration ./tests/system
 
-.PHONY: up
-up:
-	@echo "$(GREEN_COLOR)==> up $(RESET_COLOR)"
+.PHONY: docker-up
+docker-up:
 	@docker-compose up -d
 
-.PHONY: remove
-remove:
-	@echo "$(GREEN_COLOR)==> rm $(RESET_COLOR)"
-	@docker-compose rm -f -s
-
-.PHONY: wait_up
-wait_up:
-	@echo "$(GREEN_COLOR)==> wait_up $(RESET_COLOR)"
-	@for i in `seq 0 180`; do if docker exec -it $(CONTAINER_NAME) /sbin/checkstate.sh &> /dev/null; then break; fi; printf "\rWaiting for Splunk for %s seconds..." $$i; sleep 1; done
-
-.PHONY: down
-down:
-	@echo "$(GREEN_COLOR)==> down $(RESET_COLOR)"
+.PHONY: docker-ensure-up
+docker-ensure-up:
+	@for i in `seq 0 180`; do \
+		if docker exec -it $(CONTAINER_NAME) /bin/bash -c "/sbin/checkstate.sh &> /dev/null"; then \
+			break; \
+		fi; \
+		printf "\rWaiting for Splunk for %s seconds..." $$i; \
+		sleep 1; \
+	done
+
+.PHONY: docker-start
+docker-start: docker-up docker-ensure-up
+
+.PHONY: docker-down
+docker-down:
 	@docker-compose stop
 
-.PHONY: start
-start: up wait_up
+.PHONY: docker-restart
+docker-restart: docker-down docker-start
 
-.PHONY: restart
-restart: down start
+.PHONY: docker-remove
+docker-remove:
+	@docker-compose rm -f -s
 
-.PHONY: refresh
-refresh: remove start
+.PHONY: docker-refresh
+docker-refresh: docker-remove docker-start