Restructuring example code.

This commit is contained in:
Patrick Lehmann
2025-09-01 01:06:10 +02:00
parent 729e406294
commit e5706693e2
16 changed files with 24 additions and 15 deletions

View File

@@ -11,18 +11,18 @@ jobs:
ConfigParams: ConfigParams:
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@dev uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@dev
with: with:
package_name: pyDummy package_name: myPackage
InstallParams: InstallParams:
uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev
with: with:
package_name: pyDummy package_name: myPackage
python_version_list: '' python_version_list: ''
UnitTestingParams: UnitTestingParams:
uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev
with: with:
name: pyDummy name: myPackage
python_version_list: '3.9 3.10 3.11 3.12 3.13 pypy-3.10 pypy-3.11' 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' disable_list: 'windows-arm:pypy-3.10 windows-arm:pypy-3.11'

View File

@@ -8,8 +8,8 @@ jobs:
NamespacePackage: NamespacePackage:
uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@dev uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@dev
with: with:
package_namespace: pyExamples package_namespace: myFramework
package_name: Extensions package_name: Extension
codecov: true codecov: true
codacy: true codacy: true
dorny: true dorny: true

View File

@@ -8,7 +8,7 @@ jobs:
SimplePackage: SimplePackage:
uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@dev uses: pyTooling/Actions/.github/workflows/CompletePipeline.yml@dev
with: with:
package_name: pyDummy package_name: myPackage
codecov: true codecov: true
codacy: true codacy: true
dorny: true dorny: true

2
.gitignore vendored
View File

@@ -26,7 +26,7 @@ coverage.xml
# Sphinx # Sphinx
doc/_build/ doc/_build/
doc/pyDummy/**/*.* doc/pyDummy/**/*.*
!doc/pyDummy/index.rst !doc/myPackage/index.rst
# BuildTheDocs # BuildTheDocs
doc/_theme/**/*.* doc/_theme/**/*.*

View File

@@ -3,6 +3,14 @@
Deprecated 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:: .. toctree::
:hidden: :hidden:

View File

@@ -12,7 +12,7 @@ from pyTooling.Packaging import extractVersionInformation
# ============================================================================== # ==============================================================================
githubNamespace = "pyTooling" githubNamespace = "pyTooling"
githubProject = "Actions" githubProject = "Actions"
pythonProject = "pyDummy" pythonProject = "myPackage"
directoryName = pythonProject.replace('.', '/') directoryName = pythonProject.replace('.', '/')

View File

@@ -28,23 +28,23 @@
# SPDX-License-Identifier: Apache-2.0 # # SPDX-License-Identifier: Apache-2.0 #
# ==================================================================================================================== # # ==================================================================================================================== #
# #
"""Package installer for 'pyDummy'.""" """Package installer for 'myPackage'."""
from setuptools import setup from setuptools import setup
from pathlib import Path from pathlib import Path
from pyTooling.Packaging import DescribePythonPackageHostedOnGitHub from pyTooling.Packaging import DescribePythonPackageHostedOnGitHub
gitHubNamespace = "pyTooling" gitHubNamespace = "pyTooling"
packageName = "pyDummy" packageName = "myPackage"
packageDirectory = packageName packageDirectory = packageName
packageInformationFile = Path(f"{packageDirectory}/__init__.py") packageInformationFile = Path(f"{packageDirectory}/__init__.py")
setup( setup(
**DescribePythonPackageHostedOnGitHub( **DescribePythonPackageHostedOnGitHub(
packageName=packageName, 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, gitHubNamespace=gitHubNamespace,
unittestRequirementsFile=Path("tests/requirements.txt"), unittestRequirementsFile=Path("tests/unit/requirements.txt"),
sourceFileWithVersion=packageInformationFile, sourceFileWithVersion=packageInformationFile,
dataFiles={ dataFiles={
packageName: ["py.typed"] packageName: ["py.typed"]

View File

@@ -33,7 +33,7 @@ from unittest import TestCase
from pytest import mark from pytest import mark
from pyTooling.Platform import CurrentPlatform from pyTooling.Platform import CurrentPlatform
from pyDummy import Application from myPackage import Application
if __name__ == "__main__": # pragma: no cover if __name__ == "__main__": # pragma: no cover

View File

@@ -0,0 +1 @@
-r ../requirements.txt

View File

@@ -30,7 +30,7 @@
# #
from unittest import TestCase from unittest import TestCase
from pyDummy import Application from myPackage import Application
class Instantiation(TestCase): class Instantiation(TestCase):

View File

@@ -28,4 +28,4 @@
# SPDX-License-Identifier: Apache-2.0 # # SPDX-License-Identifier: Apache-2.0 #
# ==================================================================================================================== # # ==================================================================================================================== #
# #
"""Test code for pyDummy.""" """Test code for myPackage."""