From e5706693e27a612ecf99b65bc536615bf57b57ae Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Mon, 1 Sep 2025 01:06:10 +0200 Subject: [PATCH] Restructuring example code. --- .github/workflows/_Checking_JobTemplates.yml | 6 +++--- .github/workflows/_Checking_NamespacePackage_Pipeline.yml | 4 ++-- .github/workflows/_Checking_SimplePackage_Pipeline.yml | 2 +- .gitignore | 2 +- doc/JobTemplate/Deprecated/index.rst | 8 ++++++++ doc/conf.py | 2 +- doc/{pyDummy => myPackage}/.gitempty | 0 .../Extensions => myFramework/Extension}/__init__.py | 0 {pyDummy => myFramework/Extension}/py.typed | 0 {pyDummy => myPackage}/__init__.py | 0 {pyExamples/Extensions => myPackage}/py.typed | 0 setup.py | 8 ++++---- tests/platform/Specific.py | 2 +- tests/platform/requirements.txt | 1 + tests/unit/{Dummy.py => AppInit.py} | 2 +- tests/unit/__init__.py | 2 +- 16 files changed, 24 insertions(+), 15 deletions(-) rename doc/{pyDummy => myPackage}/.gitempty (100%) rename {pyExamples/Extensions => myFramework/Extension}/__init__.py (100%) rename {pyDummy => myFramework/Extension}/py.typed (100%) rename {pyDummy => myPackage}/__init__.py (100%) rename {pyExamples/Extensions => myPackage}/py.typed (100%) create mode 100644 tests/platform/requirements.txt rename tests/unit/{Dummy.py => AppInit.py} (99%) diff --git a/.github/workflows/_Checking_JobTemplates.yml b/.github/workflows/_Checking_JobTemplates.yml index 9b39ac6..2bd4b60 100644 --- a/.github/workflows/_Checking_JobTemplates.yml +++ b/.github/workflows/_Checking_JobTemplates.yml @@ -11,18 +11,18 @@ jobs: ConfigParams: uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@dev with: - package_name: pyDummy + package_name: myPackage InstallParams: uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev with: - package_name: pyDummy + package_name: myPackage python_version_list: '' UnitTestingParams: uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev with: - name: pyDummy + name: myPackage python_version_list: '3.9 3.10 3.11 3.12 3.13 pypy-3.10 pypy-3.11' disable_list: 'windows-arm:pypy-3.10 windows-arm:pypy-3.11' diff --git a/.github/workflows/_Checking_NamespacePackage_Pipeline.yml b/.github/workflows/_Checking_NamespacePackage_Pipeline.yml index a0eb01b..f59baaa 100644 --- a/.github/workflows/_Checking_NamespacePackage_Pipeline.yml +++ b/.github/workflows/_Checking_NamespacePackage_Pipeline.yml @@ -8,8 +8,8 @@ jobs: NamespacePackage: uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@dev with: - package_namespace: pyExamples - package_name: Extensions + package_namespace: myFramework + package_name: Extension codecov: true codacy: true dorny: true diff --git a/.github/workflows/_Checking_SimplePackage_Pipeline.yml b/.github/workflows/_Checking_SimplePackage_Pipeline.yml index 7232618..714c04d 100644 --- a/.github/workflows/_Checking_SimplePackage_Pipeline.yml +++ b/.github/workflows/_Checking_SimplePackage_Pipeline.yml @@ -8,7 +8,7 @@ jobs: SimplePackage: uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@dev with: - package_name: pyDummy + package_name: myPackage codecov: true codacy: true dorny: true diff --git a/.gitignore b/.gitignore index 09fadda..f2c0f24 100644 --- a/.gitignore +++ b/.gitignore @@ -26,7 +26,7 @@ coverage.xml # Sphinx doc/_build/ doc/pyDummy/**/*.* -!doc/pyDummy/index.rst +!doc/myPackage/index.rst # BuildTheDocs doc/_theme/**/*.* diff --git a/doc/JobTemplate/Deprecated/index.rst b/doc/JobTemplate/Deprecated/index.rst index f541957..ee2af91 100644 --- a/doc/JobTemplate/Deprecated/index.rst +++ b/doc/JobTemplate/Deprecated/index.rst @@ -3,6 +3,14 @@ Deprecated ########## +The category *deprecated* collects outdated job templates: + +:ref:`JOBTMPL/CoverageCollection` + replaced by :ref:`JOBTMPL/UnitTesting` +:ref:`JOBTMPL/NightlyRelease` + replaced by :ref:`JOBTMPL/PublishReleaseNotes` +:ref:`JOBTMPL/BuildTheDocs` + replaced by :ref:`JOBTMPL/SphinxDocumentation` and :ref:`JOBTMPL/LaTeXDocumentation` .. toctree:: :hidden: diff --git a/doc/conf.py b/doc/conf.py index 6732434..7f2c9a1 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -12,7 +12,7 @@ from pyTooling.Packaging import extractVersionInformation # ============================================================================== githubNamespace = "pyTooling" githubProject = "Actions" -pythonProject = "pyDummy" +pythonProject = "myPackage" directoryName = pythonProject.replace('.', '/') diff --git a/doc/pyDummy/.gitempty b/doc/myPackage/.gitempty similarity index 100% rename from doc/pyDummy/.gitempty rename to doc/myPackage/.gitempty diff --git a/pyExamples/Extensions/__init__.py b/myFramework/Extension/__init__.py similarity index 100% rename from pyExamples/Extensions/__init__.py rename to myFramework/Extension/__init__.py diff --git a/pyDummy/py.typed b/myFramework/Extension/py.typed similarity index 100% rename from pyDummy/py.typed rename to myFramework/Extension/py.typed diff --git a/pyDummy/__init__.py b/myPackage/__init__.py similarity index 100% rename from pyDummy/__init__.py rename to myPackage/__init__.py diff --git a/pyExamples/Extensions/py.typed b/myPackage/py.typed similarity index 100% rename from pyExamples/Extensions/py.typed rename to myPackage/py.typed diff --git a/setup.py b/setup.py index f6b637a..6b3865a 100644 --- a/setup.py +++ b/setup.py @@ -28,23 +28,23 @@ # SPDX-License-Identifier: Apache-2.0 # # ==================================================================================================================== # # -"""Package installer for 'pyDummy'.""" +"""Package installer for 'myPackage'.""" from setuptools import setup from pathlib import Path from pyTooling.Packaging import DescribePythonPackageHostedOnGitHub gitHubNamespace = "pyTooling" -packageName = "pyDummy" +packageName = "myPackage" packageDirectory = packageName packageInformationFile = Path(f"{packageDirectory}/__init__.py") setup( **DescribePythonPackageHostedOnGitHub( packageName=packageName, - description="pyDummy is a test package to verify GitHub actions for Python projects.", + description="myPackage is a test package to verify GitHub actions for Python projects.", gitHubNamespace=gitHubNamespace, - unittestRequirementsFile=Path("tests/requirements.txt"), + unittestRequirementsFile=Path("tests/unit/requirements.txt"), sourceFileWithVersion=packageInformationFile, dataFiles={ packageName: ["py.typed"] diff --git a/tests/platform/Specific.py b/tests/platform/Specific.py index 8ce4fe5..b2676f8 100644 --- a/tests/platform/Specific.py +++ b/tests/platform/Specific.py @@ -33,7 +33,7 @@ from unittest import TestCase from pytest import mark from pyTooling.Platform import CurrentPlatform -from pyDummy import Application +from myPackage import Application if __name__ == "__main__": # pragma: no cover diff --git a/tests/platform/requirements.txt b/tests/platform/requirements.txt new file mode 100644 index 0000000..3c8d7e7 --- /dev/null +++ b/tests/platform/requirements.txt @@ -0,0 +1 @@ +-r ../requirements.txt diff --git a/tests/unit/Dummy.py b/tests/unit/AppInit.py similarity index 99% rename from tests/unit/Dummy.py rename to tests/unit/AppInit.py index 798b07c..13a5200 100644 --- a/tests/unit/Dummy.py +++ b/tests/unit/AppInit.py @@ -30,7 +30,7 @@ # from unittest import TestCase -from pyDummy import Application +from myPackage import Application class Instantiation(TestCase): diff --git a/tests/unit/__init__.py b/tests/unit/__init__.py index 78d8bba..c0e06b8 100644 --- a/tests/unit/__init__.py +++ b/tests/unit/__init__.py @@ -28,4 +28,4 @@ # SPDX-License-Identifier: Apache-2.0 # # ==================================================================================================================== # # -"""Test code for pyDummy.""" +"""Test code for myPackage."""