python-template-project 0.2.0__tar.gz → 0.2.1__tar.gz

{python_template_project-0.2.0 → python_template_project-0.2.1}/.github/rename_project.sh

@@ -74,5 +74,8 @@ fi
 # Remove the template.yml to indicate that the template has been applied
 echo "Removing .github/template.yml"
 rm -f .github/template.yml
+# Remove rename_project.yml to prevent re-running the renaming script
+echo "Removing .github/workflows/rename_project.yml"
+rm -f .github/workflows/rename_project.yml
 
 echo "Project renaming complete!"

python_template_project-0.2.1/.github/update_funding.py

@@ -0,0 +1,46 @@
+# scripts/update_funding.py
+from pathlib import Path
+import requests
+import sys
+
+# Define the URL of your central FUNDING.md file on GitHub
+FUNDING_REPO_URL = "https://raw.githubusercontent.com/pamagister/FUNDING/main/README.md"
+
+# Define the destination path within the current repository
+# This will create 'docs/funding/funding.md'
+DST_THIS_REPO = Path("docs/funding/funding.md")
+
+
+def update_funding_file():
+    """
+    Downloads the FUNDING.md file from the central repository
+    and saves it to the specified path within the current repository.
+    """
+    print(f"Attempting to download FUNDING.md from: {FUNDING_REPO_URL}")
+
+    try:
+        # Send a GET request to the URL
+        response = requests.get(FUNDING_REPO_URL)
+        response.raise_for_status()  # Raise an HTTPError for bad responses (4xx or 5xx)
+
+        # Ensure the parent directory (e.g., 'docs/funding/') exists
+        DST_THIS_REPO.parent.mkdir(parents=True, exist_ok=True)
+
+        # Write the content to the destination file
+        with open(DST_THIS_REPO, "wb") as f:
+            f.write(response.content)
+
+        print(f"Successfully updated FUNDING.md at: {DST_THIS_REPO}")
+
+    except requests.exceptions.RequestException as e:
+        print(f"Error downloading FUNDING.md: {e}", file=sys.stderr)
+        sys.exit(1)  # Exit with an error code
+    except IOError as e:
+        print(f"Error writing FUNDING.md to file: {e}", file=sys.stderr)
+        sys.exit(1)  # Exit with an error code
+
+
+if __name__ == "__main__":
+    # Ensure the 'requests' library is installed for this script to run.
+    # If not, install it using: pip install requests
+    update_funding_file()

{python_template_project-0.2.0 → python_template_project-0.2.1}/.gitignore

@@ -197,3 +197,7 @@ cython_debug/
 /.idea/python-template-project.iml
 /.idea/inspectionProfiles/profiles_settings.xml
 /.idea/inspectionProfiles/Project_Default.xml
+/src/python_template_project/_version.py
+/release/config.yaml
+/release/python-template-project.exe
+/release/README.md

python_template_project-0.2.1/.pre-commit-config-linux.yaml

@@ -0,0 +1,15 @@
+# the actual pre-commit is defined in the Makefile
+# install and activate pre-commit:
+# > pre-commit install
+#
+# on Linux, rename this file to .pre-commit-config.yaml and use this one
+
+repos:
+  - repo: local
+    hooks:
+      - id: run-make-precommit
+        name: Run `make precommit`
+        entry: bash -c "export PATH=$HOME/.local/bin:$PATH && uv run make precommit"
+        language: system
+        always_run: true
+        pass_filenames: false

{python_template_project-0.2.0 → python_template_project-0.2.1}/HISTORY.md

@@ -1,262 +1,297 @@
-Changelog
-=========
-
-
-(unreleased)
-------------
-- Feat #33: Support kml files for input and display output files as
-  clickable links #33. [Paul Magister]
-- Feat #31: move project specific namings into makefile so that it can
-  be renamed. [Paul Magister]
-
-
-0.1.20 (2025-06-20)
--------------------
-- Feat #31: move project specific namings into makefile so that it can
-  be renamed. [Paul Magister]
-- Feat #31: move project specific namings into makefile so that it can
-  be renamed. [Paul Magister]
-
-
-0.1.19 (2025-06-20)
--------------------
-- Feat #31: move project specific namings into makefile so that it can
-  be renamed. [Paul Magister]
-- Feat #31: try this renaming automation. [Paul Magister]
-- Feat #31: improve renaming automation: has to be triggered manually,
-  keep kebab-case if project is named like this. [Paul Magister]
-- Feat #31: improve renaming automation: has to be triggered manually,
-  keep kebab-case if project is named like this. [Paul Magister]
-- Feat #31: improve renaming automation: has to be triggered manually,
-  keep kebab-case if project is named like this. [Paul Magister]
-- Feat #31: consistent naming. [Paul Magister]
-- Feat #31: fix rename_project.yml: use correct git auto commit. [Paul
-  Magister]
-- Feat #31: fix rename_project.yml: use correct git auto commit. [Paul
-  Magister]
-- Feat #30: fix link issue by modifying link in README.md. [Paul
-  Magister]
-
-
-0.1.18 (2025-06-20)
--------------------
-- Feat #30: do not track _version.py. [Paul Magister]
-- Feat #30: fix version. [Paul Magister]
-
-
-0.1.17 (2025-06-20)
--------------------
-- Feat #30: fix link issue by modifying link in README.md. [Paul
-  Magister]
-
-
-0.1.16 (2025-06-20)
--------------------
-- Fix #29: more rubust usage of srtm in case of connection issues. [Paul
-  Magister]
-- Feat #30: exclude _version.py from check. [Paul Magister]
-- Feat #31: doc on how to generate. [Paul Magister]
-- Feat #30: exclude _version.py from check. [Paul Magister]
-- Feat #31: enable project to be copied #31. [Paul Magister]
-- Feat #27: move build logic into make file #27. [Paul Magister]
-- Feat #30: improve README.md, fix utf8-issues on copying. [Paul
-  Magister]
-- Feat #30: correct doc how to install and use this project. [Paul
-  Magister]
-- Feat #30: add _version.py instead of VERSION. [Paul Magister]
-- Update README.md from docs/index.md. [github-actions]
-
-
-0.1.15 (2025-06-20)
--------------------
-- Feat #30: switch build system to setuptools_scm. [Paul Magister]
-- Feat #30: add some links to the doc. [Paul Magister]
-
-
-0.1.14 (2025-06-20)
--------------------
-- Feat #30: release project on pypi: deploy section in release.yml.
-  [Paul Magister]
-- Feat #30: release project on pypi: rename contributing section, add
-  pypi_release.md doc. [Paul Magister]
-
-
-0.1.13 (2025-06-19)
--------------------
-- Feat #16: fix installer link and name. [Paul Magister]
-- Feat #16: release. [Paul Magister]
-
-
-0.1.12 (2025-06-19)
--------------------
-- Feat #16: remove old mbox strings and adjust names. [Paul Magister]
-- Feat #16: release. [Paul Magister]
-- Update README.md from docs/index.md. [github-actions]
-
-
-0.1.11 (2025-06-19)
--------------------
-- Feat #29: Generate elevation of points optionally, bugfix loop in main
-  gui, [Paul Magister]
-- Feat #28: Multiple file list conversion and merging #28. [Paul
-  Magister]
-- Feat #14: GUI: add buttons and run menu for each functionality. [Paul
-  Magister]
-- Feat #14: GUI: do NOT display required param in settings dialog. it
-  has to be set every time via gui. [Paul Magister]
-- Feat #23: little refactorings on gpx. [Paul Magister]
-- Feat #14: GUI: mention tkinker in docs. [Paul Magister]
-- Feat #18: Logging enabled in converter logic. [Paul Magister]
-- Merge pull request #15 from
-  pamagister/dependabot/github_actions/softprops/action-gh-release-2.
-  [Paul Magister]
-
-  Bump softprops/action-gh-release from 1 to 2
-- Bump softprops/action-gh-release from 1 to 2. [dependabot[bot]]
-
-  Bumps [softprops/action-gh-release](https://github.com/softprops/action-gh-release) from 1 to 2.
-  - [Release notes](https://github.com/softprops/action-gh-release/releases)
-  - [Changelog](https://github.com/softprops/action-gh-release/blob/master/CHANGELOG.md)
-  - [Commits](https://github.com/softprops/action-gh-release/compare/v1...v2)
-
-  ---
-  updated-dependencies:
-  - dependency-name: softprops/action-gh-release
-    dependency-version: '2'
-    dependency-type: direct:production
-    update-type: version-update:semver-major
-  ...
-- Feat #26: unit-tests gpx functionality #26. [Paul Magister]
-- Feat #23: Implement gpx functionality: adjust interface. [Paul
-  Magister]
-- Feat #16: generate relative paths and improve filtering and visuals.
-  [Paul Magister]
-- Feat #25: add example gpx data #25. [Paul Magister]
-- Feat #23: Implement gpx functionality #23. [Paul Magister]
-- Feat #22: Auto-generate parameters md doc #22. [Paul Magister]
-
-
-0.1.10 (2025-06-17)
--------------------
-- Feat #21: Build unified executable (gui and cli) for mac os. [Paul
-  Magister]
-
-
-0.1.9 (2025-06-17)
-------------------
-- Feat #21: Build unified executable (gui and cli) #21. [Paul Magister]
-- Feat #20: Makefile: Generate file tree #20. [Paul Magister]
-- Feat #16: make release. [Paul Magister]
-- Feat #16: fix doc: add git init commands. [Paul Magister]
-
-
-0.1.8 (2025-06-17)
-------------------
-- Feat #16: fix doc: command line prompts. [Paul Magister]
-- Fix #19: Workaround for deptree issue 295 #19. [Paul Magister]
-- Feat #16: new release. [Paul Magister]
-
-
-0.1.7 (2025-06-17)
-------------------
-- Feat #8: CI: build macos: more echo. [Paul Magister]
-- Feat #7: CI: build windows: more echo. [Paul Magister]
-- Feat #7: CI: Create workflow for building Windows executable: fix
-  script: remove unneccessary ** [Paul Magister]
-- Feat #7: CI: Create workflow for building Windows executable: english.
-  [Paul Magister]
-- Feat #7: CI: Create workflow for building Windows executable. [Paul
-  Magister]
-- Feat #7: CI: Create workflow for building Windows executable. [Paul
-  Magister]
-- Feat #8: CI: Create workflow for building macOS installer/app bundle.
-  [Paul Magister]
-- Feat #7: CI: Create workflow for building Windows executable. [Paul
-  Magister]
-- Feat #17: cleanup doc. [Paul Magister]
-- Feat #16: adjust doc. [Paul Magister]
-- Feat #18: fix deprecation warning. [Paul Magister]
-- Feat #18: fix tests. [Paul Magister]
-- Feat #18: add logging for gui. [Paul Magister]
-- Feat #18: fix. [Paul Magister]
-- Feat #18: Logging framework. [Paul Magister]
-
-
-0.1.6 (2025-06-17)
-------------------
-- Feat #18: Logging framework. [Paul Magister]
-- Feat #14: add run configurations. [Paul Magister]
-- Feat #14: Implement minimalist GUI with an auto-generated settings
-  menu. [Paul Magister]
-- Feat #10: massive refactoring on parameter and config handling: fix
-  tests. [Paul Magister]
-- Feat #10: massive refactoring on parameter and config handling: remove
-  parameters.py. [Paul Magister]
-- Feat #10: massive refactoring on parameter and config handling. [Paul
-  Magister]
-- Feat #17: genberal refactoring. [Paul Magister]
-- Feat #13: rename image. [Paul Magister]
-- Feat #11: adjust posituonal parameter to be more general. [Paul
-  Magister]
-- Feat #17: structural refactorings, fix import issues. [Paul Magister]
-- Feat #17: structural refactorings. [Paul Magister]
-- Feat #11: suitable cli parameters for this example workspace. [Paul
-  Magister]
-- Feat #5: Makefile better debugable. [Paul Magister]
-- Feat #12: add cli nav. [Paul Magister]
-- Feat #16: release. [Paul Magister]
-
-
-0.1.5 (2025-06-16)
-------------------
-- Feat #12: add cli nav. [Paul Magister]
-- Feat #12: cli documentation. [Paul Magister]
-- Feat #16: make the sh files runnable using: ```git update-index
-  --chmod=+x ./.github/release_message.sh``` [Paul Magister]
-- Feat #16: release. [Paul Magister]
-
-
-0.1.3 (2025-06-16)
-------------------
-- Feat #16: release: remove redundand VERSION and HISTORY push. [Paul
-  Magister]
-- Feat #16: release. [Paul Magister]
-
-
-0.1.2 (2025-06-16)
-------------------
-- Feat #16: Make release_message.sh executable. [Paul Magister]
-- Feat #16: release. [Paul Magister]
-
-
-0.1.1 (2025-06-15)
-------------------
-- Feat #2: Configure pre-commit hook with black for code formatting.
-  [Paul Magister]
-- Feat #13: auto-copy readme. [Paul Magister]
-- Feat #13: auto-copy readme. [Paul Magister]
-- Feat #13: add correct image. [Paul Magister]
-- Feat #10: adjust automatic generation of config files from parameters.
-  [Paul Magister]
-- Feat #2: auto-format code, adjust Makefile #6: make github actions
-  running finally. [Paul Magister]
-- Feat #2: auto-format code, adjust Makefile. [Paul Magister]
-- Feat #2: auto-format code. [Paul Magister]
-- Feat #1: Setup unit testing with pytest. [Paul Magister]
-- Feat #6: Implement GitHub Actions for test, and checks. [Paul
-  Magister]
-- Feat #10: Implement automatic generation of config files from
-  parameters. [Paul Magister]
-- Feat #11: Implement automatic generation of a CLI from parameters.
-  [Paul Magister]
-- Feat #4: adjust project names. [Paul Magister]
-- Feat #4: Manage dependencies via pyproject.toml. [Paul Magister]
-- Feat #5: Makefile for automating common development tasks. [Paul
-  Magister]
-- Merge remote-tracking branch 'origin/main' [Paul Magister]
-- Feat #13: add readthedocs config. [Paul Magister]
-- Feat #13: add readthedocs config. [Paul Magister]
-- Feat #13: initial README.md. [Paul Magister]
-- Initial commit. [Paul Magister]
-
-
+Changelog
+=========
+
+
+(unreleased)
+------------
+- Update to new config: use .value to be type save. [Paul Magister]
+- Contributing.md: troubleshooting make release issue. [Paul Magister]
+- Linux setup details. [paul]
+- Feat #34: generate cli and config.md on make docs. [Paul Magister]
+- Update README.md from docs/index.md. [github-actions]
+- Feat #34: update to config-cli-gui 0.1.1. [Paul Magister]
+- Feat #31: delete rename_project.yml. [Paul Magister]
+- Feat #34: use config-cli-gui library. [Paul Magister]
+- Feat #35: funding page centralized #35. [Paul Magister]
+
+
+0.2.0 (2025-06-22)
+------------------
+- Feat #34: prepare config and gui to be used as library: massive
+  refactoring. [Paul Magister]
+- Feat #34: prepare config and gui to be used as library #34. [Paul
+  Magister]
+- Feat #20: Makefile: python tree: all class attributes in one line.
+  [Paul Magister]
+- Update README.md from docs/index.md. [github-actions]
+- Feat #31: update docs: usage guide for this template. [Paul Magister]
+- Feat #31: update docs: remove unneeded part of get_logging_config.
+  [Paul Magister]
+- Feat #31: update docs: move installation description below. Describe
+  features first. [Paul Magister]
+- Feat #20: Makefile: Generate file tree including python internals.
+  [Paul Magister]
+- Feat #31: move Prepare ZIP file for release into build-macos.yml.
+  [Paul Magister]
+- Feat #33: Support kml files for input and display output files as
+  clickable links #33. [Paul Magister]
+
+
+0.1.21 (2025-06-21)
+-------------------
+- Feat #33: Support kml files for input and display output files as
+  clickable links #33. [Paul Magister]
+- Feat #31: move project specific namings into makefile so that it can
+  be renamed. [Paul Magister]
+
+
+0.1.20 (2025-06-20)
+-------------------
+- Feat #31: move project specific namings into makefile so that it can
+  be renamed. [Paul Magister]
+- Feat #31: move project specific namings into makefile so that it can
+  be renamed. [Paul Magister]
+
+
+0.1.19 (2025-06-20)
+-------------------
+- Feat #31: move project specific namings into makefile so that it can
+  be renamed. [Paul Magister]
+- Feat #31: try this renaming automation. [Paul Magister]
+- Feat #31: improve renaming automation: has to be triggered manually,
+  keep kebab-case if project is named like this. [Paul Magister]
+- Feat #31: improve renaming automation: has to be triggered manually,
+  keep kebab-case if project is named like this. [Paul Magister]
+- Feat #31: improve renaming automation: has to be triggered manually,
+  keep kebab-case if project is named like this. [Paul Magister]
+- Feat #31: consistent naming. [Paul Magister]
+- Feat #31: fix rename_project.yml: use correct git auto commit. [Paul
+  Magister]
+- Feat #31: fix rename_project.yml: use correct git auto commit. [Paul
+  Magister]
+- Feat #30: fix link issue by modifying link in README.md. [Paul
+  Magister]
+
+
+0.1.18 (2025-06-20)
+-------------------
+- Feat #30: do not track _version.py. [Paul Magister]
+- Feat #30: fix version. [Paul Magister]
+
+
+0.1.17 (2025-06-20)
+-------------------
+- Feat #30: fix link issue by modifying link in README.md. [Paul
+  Magister]
+
+
+0.1.16 (2025-06-20)
+-------------------
+- Fix #29: more rubust usage of srtm in case of connection issues. [Paul
+  Magister]
+- Feat #30: exclude _version.py from check. [Paul Magister]
+- Feat #31: doc on how to generate. [Paul Magister]
+- Feat #30: exclude _version.py from check. [Paul Magister]
+- Feat #31: enable project to be copied #31. [Paul Magister]
+- Feat #27: move build logic into make file #27. [Paul Magister]
+- Feat #30: improve README.md, fix utf8-issues on copying. [Paul
+  Magister]
+- Feat #30: correct doc how to install and use this project. [Paul
+  Magister]
+- Feat #30: add _version.py instead of VERSION. [Paul Magister]
+- Update README.md from docs/index.md. [github-actions]
+
+
+0.1.15 (2025-06-20)
+-------------------
+- Feat #30: switch build system to setuptools_scm. [Paul Magister]
+- Feat #30: add some links to the doc. [Paul Magister]
+
+
+0.1.14 (2025-06-20)
+-------------------
+- Feat #30: release project on pypi: deploy section in release.yml.
+  [Paul Magister]
+- Feat #30: release project on pypi: rename contributing section, add
+  pypi_release.md doc. [Paul Magister]
+
+
+0.1.13 (2025-06-19)
+-------------------
+- Feat #16: fix installer link and name. [Paul Magister]
+- Feat #16: release. [Paul Magister]
+
+
+0.1.12 (2025-06-19)
+-------------------
+- Feat #16: remove old mbox strings and adjust names. [Paul Magister]
+- Feat #16: release. [Paul Magister]
+- Update README.md from docs/index.md. [github-actions]
+
+
+0.1.11 (2025-06-19)
+-------------------
+- Feat #29: Generate elevation of points optionally, bugfix loop in main
+  gui, [Paul Magister]
+- Feat #28: Multiple file list conversion and merging #28. [Paul
+  Magister]
+- Feat #14: GUI: add buttons and run menu for each functionality. [Paul
+  Magister]
+- Feat #14: GUI: do NOT display required param in settings dialog. it
+  has to be set every time via gui. [Paul Magister]
+- Feat #23: little refactorings on gpx. [Paul Magister]
+- Feat #14: GUI: mention tkinker in docs. [Paul Magister]
+- Feat #18: Logging enabled in converter logic. [Paul Magister]
+- Merge pull request #15 from
+  pamagister/dependabot/github_actions/softprops/action-gh-release-2.
+  [Paul Magister]
+
+  Bump softprops/action-gh-release from 1 to 2
+- Bump softprops/action-gh-release from 1 to 2. [dependabot[bot]]
+
+  Bumps [softprops/action-gh-release](https://github.com/softprops/action-gh-release) from 1 to 2.
+  - [Release notes](https://github.com/softprops/action-gh-release/releases)
+  - [Changelog](https://github.com/softprops/action-gh-release/blob/master/CHANGELOG.md)
+  - [Commits](https://github.com/softprops/action-gh-release/compare/v1...v2)
+
+  ---
+  updated-dependencies:
+  - dependency-name: softprops/action-gh-release
+    dependency-version: '2'
+    dependency-type: direct:production
+    update-type: version-update:semver-major
+  ...
+- Feat #26: unit-tests gpx functionality #26. [Paul Magister]
+- Feat #23: Implement gpx functionality: adjust interface. [Paul
+  Magister]
+- Feat #16: generate relative paths and improve filtering and visuals.
+  [Paul Magister]
+- Feat #25: add example gpx data #25. [Paul Magister]
+- Feat #23: Implement gpx functionality #23. [Paul Magister]
+- Feat #22: Auto-generate parameters md doc #22. [Paul Magister]
+
+
+0.1.10 (2025-06-17)
+-------------------
+- Feat #21: Build unified executable (gui and cli) for mac os. [Paul
+  Magister]
+
+
+0.1.9 (2025-06-17)
+------------------
+- Feat #21: Build unified executable (gui and cli) #21. [Paul Magister]
+- Feat #20: Makefile: Generate file tree #20. [Paul Magister]
+- Feat #16: make release. [Paul Magister]
+- Feat #16: fix doc: add git init commands. [Paul Magister]
+
+
+0.1.8 (2025-06-17)
+------------------
+- Feat #16: fix doc: command line prompts. [Paul Magister]
+- Fix #19: Workaround for deptree issue 295 #19. [Paul Magister]
+- Feat #16: new release. [Paul Magister]
+
+
+0.1.7 (2025-06-17)
+------------------
+- Feat #8: CI: build macos: more echo. [Paul Magister]
+- Feat #7: CI: build windows: more echo. [Paul Magister]
+- Feat #7: CI: Create workflow for building Windows executable: fix
+  script: remove unneccessary ** [Paul Magister]
+- Feat #7: CI: Create workflow for building Windows executable: english.
+  [Paul Magister]
+- Feat #7: CI: Create workflow for building Windows executable. [Paul
+  Magister]
+- Feat #7: CI: Create workflow for building Windows executable. [Paul
+  Magister]
+- Feat #8: CI: Create workflow for building macOS installer/app bundle.
+  [Paul Magister]
+- Feat #7: CI: Create workflow for building Windows executable. [Paul
+  Magister]
+- Feat #17: cleanup doc. [Paul Magister]
+- Feat #16: adjust doc. [Paul Magister]
+- Feat #18: fix deprecation warning. [Paul Magister]
+- Feat #18: fix tests. [Paul Magister]
+- Feat #18: add logging for gui. [Paul Magister]
+- Feat #18: fix. [Paul Magister]
+- Feat #18: Logging framework. [Paul Magister]
+
+
+0.1.6 (2025-06-17)
+------------------
+- Feat #18: Logging framework. [Paul Magister]
+- Feat #14: add run configurations. [Paul Magister]
+- Feat #14: Implement minimalist GUI with an auto-generated settings
+  menu. [Paul Magister]
+- Feat #10: massive refactoring on parameter and config handling: fix
+  tests. [Paul Magister]
+- Feat #10: massive refactoring on parameter and config handling: remove
+  parameters.py. [Paul Magister]
+- Feat #10: massive refactoring on parameter and config handling. [Paul
+  Magister]
+- Feat #17: genberal refactoring. [Paul Magister]
+- Feat #13: rename image. [Paul Magister]
+- Feat #11: adjust posituonal parameter to be more general. [Paul
+  Magister]
+- Feat #17: structural refactorings, fix import issues. [Paul Magister]
+- Feat #17: structural refactorings. [Paul Magister]
+- Feat #11: suitable cli parameters for this example workspace. [Paul
+  Magister]
+- Feat #5: Makefile better debugable. [Paul Magister]
+- Feat #12: add cli nav. [Paul Magister]
+- Feat #16: release. [Paul Magister]
+
+
+0.1.5 (2025-06-16)
+------------------
+- Feat #12: add cli nav. [Paul Magister]
+- Feat #12: cli documentation. [Paul Magister]
+- Feat #16: make the sh files runnable using: ```git update-index
+  --chmod=+x ./.github/release_message.sh``` [Paul Magister]
+- Feat #16: release. [Paul Magister]
+
+
+0.1.3 (2025-06-16)
+------------------
+- Feat #16: release: remove redundand VERSION and HISTORY push. [Paul
+  Magister]
+- Feat #16: release. [Paul Magister]
+
+
+0.1.2 (2025-06-16)
+------------------
+- Feat #16: Make release_message.sh executable. [Paul Magister]
+- Feat #16: release. [Paul Magister]
+
+
+0.1.1 (2025-06-15)
+------------------
+- Feat #2: Configure pre-commit hook with black for code formatting.
+  [Paul Magister]
+- Feat #13: auto-copy readme. [Paul Magister]
+- Feat #13: auto-copy readme. [Paul Magister]
+- Feat #13: add correct image. [Paul Magister]
+- Feat #10: adjust automatic generation of config files from parameters.
+  [Paul Magister]
+- Feat #2: auto-format code, adjust Makefile #6: make github actions
+  running finally. [Paul Magister]
+- Feat #2: auto-format code, adjust Makefile. [Paul Magister]
+- Feat #2: auto-format code. [Paul Magister]
+- Feat #1: Setup unit testing with pytest. [Paul Magister]
+- Feat #6: Implement GitHub Actions for test, and checks. [Paul
+  Magister]
+- Feat #10: Implement automatic generation of config files from
+  parameters. [Paul Magister]
+- Feat #11: Implement automatic generation of a CLI from parameters.
+  [Paul Magister]
+- Feat #4: adjust project names. [Paul Magister]
+- Feat #4: Manage dependencies via pyproject.toml. [Paul Magister]
+- Feat #5: Makefile for automating common development tasks. [Paul
+  Magister]
+- Merge remote-tracking branch 'origin/main' [Paul Magister]
+- Feat #13: add readthedocs config. [Paul Magister]
+- Feat #13: add readthedocs config. [Paul Magister]
+- Feat #13: initial README.md. [Paul Magister]
+- Initial commit. [Paul Magister]
+
+