Add CI workflow, build script, and setup for package versioning

Author: Antoine

.github/workflows/OnPush.yml

@@ -0,0 +1,43 @@
+name: On Push Workflow
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+
+    - name: Run tests
+      run: make tests
+
+    - name: Upload test reports
+      uses: actions/upload-artifact@v3
+      with:
+        name: test-reports
+        path: tests_reports/
+
+    - name: publish test report
+      uses: mikepenz/action-junit-report@v5
+      with:
+        report_paths: tests_reports/**/report.xml
+        include_passed: true

build_package.py

@@ -0,0 +1,25 @@
+"""
+This script builds a Python package using the `build` module.
+It allows for passing additional arguments to the build command and
+supports specifying a version number via command line arguments.
+It also sets the `PACKAGE_VERSION` environment variable if a version is provided.
+"""
+
+import os
+import subprocess
+import sys
+
+if "--version" in sys.argv:
+    idx = sys.argv.index("--version")
+    version = sys.argv[idx + 1]
+    os.environ["PACKAGE_VERSION"] = version
+    sys.argv.pop(idx)  # remove --version
+    sys.argv.pop(idx)  # remove version value
+
+print(f"{sys.executable} -m build {' '.join(sys.argv[1:])}")
+try:
+    subprocess.run([sys.executable, "-m", "build"] + sys.argv[1:],
+               check=True, stderr=sys.stderr, stdout=sys.stdout)
+except subprocess.CalledProcessError as e:
+    print(f"Build failed with error code {e.returncode}")
+    sys.exit(e.returncode)

config/pyproject.toml

@@ -7,6 +7,8 @@ authors = [
 ]
 requires-python = ">=3.8"
 
+[tool.setuptools]
+packages = { find = { include = ["config*"], exclude = ["*_tests"] } }
 
 [tool.pytest.ini_options]
 minversion = "8.0"

makefile

@@ -1,21 +1,23 @@
 
+VERSION = 0.1.0
+
 MODULES = cache colors config http_code version
 
-TARGETS = $(addprefix dist/,$(addsuffix -0.1.0.tar.gz,$(MODULES)))
-TARGETS += $(addprefix dist/,$(addsuffix -0.1.0-py3-none-any.whl,$(MODULES)))
+TARGETS = $(addprefix dist/,$(addsuffix -$(VERSION).tar.gz,$(MODULES)))
+TARGETS += $(addprefix dist/,$(addsuffix -$(VERSION)-py3-none-any.whl,$(MODULES)))
 
 .PHONY: all clean tests
 
 all: $(TARGETS)
 
-dist/%-0.1.0-py3-none-any.whl: dist/%-0.1.0.tar.gz
-	python3 -m pip wheel --no-deps --wheel-dir dist $<
+dist/%-$(VERSION)-py3-none-any.whl: dist/%-$(VERSION).tar.gz
+	python -m pip wheel --no-deps --wheel-dir dist $<
 
-dist/%-0.1.0.tar.gz: %
-	python3 -m build --sdist --outdir dist $<
+dist/%-$(VERSION).tar.gz: %
+	python build_package.py --version $(VERSION) --sdist --outdir dist $<
 
 tests/%: % #with pytest
-	-coverage run -m --branch pytest --tb=short --disable-warnings --junitxml=tests_reports/$*/report.xml $<
+	-coverage run --branch -m pytest --tb=short --disable-warnings --junitxml=tests_reports/$*/report.xml $<
 	@coverage report -m
 	@coverage html -d tests_reports/$*/coverage
 	@rm .coverage

setup.py

@@ -0,0 +1,11 @@
+"""
+Setup script for the package, used by setuptools to build and install the package.
+"""
+
+import os
+
+from setuptools import setup
+
+setup(
+    version=os.environ.get("PACKAGE_VERSION", "0.0.0-dev")
+)