templatepy 0.2.6.dev0__py3-none-any.whl → 0.2.8.dev0__py3-none-any.whl

templatepy/__init__.py

@@ -1,7 +1,13 @@
 __author__ = "Lars B. Rollik"
-__version__ = "0.2.6.dev0"
+
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("subject_weight_db")
+except PackageNotFoundError:
+    __version__ = "0.2.8.dev0"
 
 
 def run():
-    """Example `run` function for entrypoint in `setup.cfg`"""
+    """Example `run` function for entrypoint defined in `pyproject.toml`."""
     print("Hello, world!")

{templatepy-0.2.6.dev0.dist-info → templatepy-0.2.8.dev0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: templatepy
-Version: 0.2.6.dev0
+Version: 0.2.8.dev0
 Summary: templatepy: Template repo for python repositories & PyPi integration
 Author-email: "Lars B. Rollik" <L.B.Rollik@protonmail.com>
 License: BSD 3-Clause License
@@ -64,7 +64,10 @@ Requires-Dist: toml; extra == "dev"
 
 [bump2version]: (https://github.com/c4urself/bump2version
 [pre-commit]: https://pre-commit.com
-[black]: https://github.com/psf/black
+
+[//]: # ([black]: https://github.com/psf/black)
+[ruff]: https://docs.astral.sh/ruff
+[mypy]: https://mypy.readthedocs.io
 
 [pypi]: pypi.org
 [test.pypi]: test.pypi.org
@@ -85,14 +88,13 @@ Requires-Dist: toml; extra == "dev"
 [![PyPI](https://img.shields.io/pypi/v/templatepy.svg)](https://pypi.org/project/templatepy)
 [![Wheel](https://img.shields.io/pypi/wheel/templatepy.svg)](https://pypi.org/project/templatepy)
 ![CI](https://github.com/larsrollik/templatepy/workflows/tests/badge.svg)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
 
 
 # templatepy
 Template repo for python repositories & PyPi integration
 ---
-**Version: "0.2.6.dev0"**
+**Version: "0.2.8.dev0"**
 
 
 ## Usage
@@ -133,7 +135,7 @@ Template repo for python repositories & PyPi integration
   Central configuration file that replaces the traditional `setup.cfg` and `setup.py` files:
   - **Build System**: Specifies the build system requirements and configuration, as defined in [PEP 518](https://peps.python.org/pep-0518/) and [PEP 621](https://peps.python.org/pep-0621/).
   - **Package Metadata**: Includes the project's metadata (name, version, dependencies, etc.).
-  - **Code Formatting**: Configuration for tools like [black] and [flake8] (if used).
+  - **Code Formatting**: Configuration for tools like [ruff] and [mypy] (if used).
   - **Optional Dependencies**: Organizes extra dependencies for development or other environments.
 
 - **`setup.py`**:
@@ -270,7 +272,8 @@ The package will then be automatically uploaded to [PyPI](https://pypi.org/) or
 3) Use bumpversion to bump the version (you can adjust patch, minor, or major based on what change you want), and create a release tag.
 4) Push both the feature branch and the release tag to the remote repository.
 5) Open a pull request using GitHub CLI (gh pr create) or the GitHub UI to merge the feature branch into main.
-6) After the PR is merged, delete the feature branch both locally and remotely.
+6) Review the pull request online or in the CLI (e.g.: `gh pr list`, `gh pr view <nr>`, `gh pr merge <nr> --merge --delete-branch`)
+7) After the PR is merged, delete the feature branch both locally and remotely.
 
 
 ### Example commands for the workflow:
@@ -302,7 +305,13 @@ gh pr create \
   --title "pr_title" \
   --body "pr_body"
 
-# 6. After the PR is accepted and merged, delete the feature branch locally and remotely
+# 6.
+gh pr list  # -> shows PRs and their IDs
+gh pr view <id>
+
+gh pr merge <id> --merge --delete-branch
+
+# 7. After the PR is accepted and merged, delete the feature branch locally and remotely
 git checkout main  # Switch back to main branch
 git pull origin main  # Ensure your main branch is up-to-date
 git branch -d feature/my-new-feature  # Delete the local feature branch
@@ -336,9 +345,11 @@ For further reading on the transition to `pyproject.toml` and the removal of `se
 - [PEP-518](https://peps.python.org/pep-0518/)
 - [Discussion on Setup.cfg Deprecation](https://stackoverflow.com/questions/44878600/is-setup-cfg-deprecated)
 
-#### Using Github CLI in actions workflows
+#### Using GitHub CLI in Workflow Actions
 
-[CLI in actions (docs)](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/using-github-cli-in-workflows)
+Easily integrate GitHub CLI into workflows to perform repository tasks. See the [GitHub CLI in workflows documentation](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/using-github-cli-in-workflows).
+
+**Example: Create a pull request**
 
 ```yaml
 - name: Create a pull request
@@ -347,6 +358,7 @@ For further reading on the transition to `pyproject.toml` and the removal of `se
     GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
 
+
 ## Common issues
 
 ### `bump2version` fails on git tag with exit status 128
@@ -356,8 +368,9 @@ For further reading on the transition to `pyproject.toml` and the removal of `se
 - there are changes that need to be committed? `git commit -am "commit message"`
 - tag already exists? `git tag` to list tags, `git tag -d <tag>` to delete a tag
 
-### no gpg key for signing commits
+### No gpg key for signing commits
 - generate a key with `gpg --full-generate-key`
+  - standard options for keys: "(9) ECC (sign and encrypt) *default*" -> Curve 25519 -> expiry 2 years: "2y" -> name/email
 - list keys with `gpg --list-secret-keys --keyid-format LONG`
 - set the key for signing commits with `git config --global user.signingkey <key-id>`
 - enable signing commits with `git config --global commit.gpgsign true`
@@ -367,7 +380,7 @@ For further reading on the transition to `pyproject.toml` and the removal of `se
 
 Which one is the key id you might ask?
 ```
-/home/user/.gnupg/secring.gpg
+/home/$USER/.gnupg/secring.gpg
 ------------------------------
 sec   4096R/<KEY_ID> 2024-11-22 [expires: 2025-11-22]
       uid                          Your Name <youremail@example.com>

templatepy-0.2.8.dev0.dist-info/RECORD

@@ -0,0 +1,11 @@
+templatepy/__init__.py,sha256=I1sCZLTc7NUOgTr3i_mDTBwOl1lz9Pb4inVy9GnWPKM,322
+templatepy/example.data.file.config,sha256=sRtbLc80ZUpGHm_qaovQ71dXmYf6IVkY8_4Y6YndGms,40
+templatepy/example.data.file.test-extension-yu48,sha256=M3siPvc7bFACsq7uBr3jbN_rd8okgr6051cJcsqPiVw,42
+tests/tests/test_integration/test_placeholder.py,sha256=cNgDUN8DaIXFUlQTBbvcqH6Js9662miE-M3AS_P1ppU,805
+tests/tests/test_unit/test_unit.py,sha256=A3bI20XzzO3xqomBtKrbc4X-X1ylDmENu0SoWKnv-ws,1518
+templatepy-0.2.8.dev0.dist-info/LICENSE,sha256=Ew8cEKZj5F51f1JVCmPZAESmeIe0HCdWdlo_NVKD-8s,1522
+templatepy-0.2.8.dev0.dist-info/METADATA,sha256=CB610oMqqkI1ozfzXmY_KYEOmi45sEovE993BfxGflo,20340
+templatepy-0.2.8.dev0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+templatepy-0.2.8.dev0.dist-info/entry_points.txt,sha256=AGxmwCmuTD2V6WaG-gZOZq9fu7X-mKRch540WR3b0aY,66
+templatepy-0.2.8.dev0.dist-info/top_level.txt,sha256=LQF8fpEG2Xs3iyqm7StHG8F9Dj-TVPOfcVeky9DtGII,17
+templatepy-0.2.8.dev0.dist-info/RECORD,,

{templatepy-0.2.6.dev0.dist-info → templatepy-0.2.8.dev0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.6.0)
+Generator: setuptools (75.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

tests/tests/test_integration/test_placeholder.py

@@ -3,13 +3,13 @@ import subprocess
 import toml
 
 
-def get_package_name():
+def get_package_name() -> str:
     """Retrieve package name from pyproject.toml."""
     project_data = toml.load("pyproject.toml")
-    return project_data["project"]["name"]
+    return str(project_data["project"]["name"])
 
 
-def test_package_functionality():
+def test_package_functionality() -> None:
     """Test the package dynamically after installation."""
     package_name = get_package_name()
 
@@ -19,13 +19,10 @@ def test_package_functionality():
     # Dynamically import the package
     result = subprocess.run(
         ["python", "-c", f"import {package_name}"],
-        stdout=subprocess.PIPE,
-        stderr=subprocess.PIPE,
+        capture_output=True,
         text=True,
     )
-    assert (
-        result.returncode == 0
-    ), f"Dynamic package import failed: {result.stderr}"
+    assert result.returncode == 0, f"Dynamic package import failed: {result.stderr}"
 
     # Cleanup: Uninstall the package
     subprocess.run(["pip", "uninstall", "-y", package_name], check=True)

tests/tests/test_unit/test_unit.py

@@ -2,7 +2,7 @@ import subprocess
 import sys
 
 
-def ensure_toml_installed():
+def ensure_toml_installed() -> None:
     """Ensure toml is installed in the current environment."""
     try:
         __import__("toml")
@@ -13,12 +13,12 @@ def ensure_toml_installed():
         )
 
 
-def test_python_version():
+def test_python_version() -> None:
     """Test that Python version is compatible with the environment."""
     assert sys.version_info >= (3, 8), "Python version must be 3.8 or higher"
 
 
-def test_package_installation():
+def test_package_installation() -> None:
     """Test dynamic installation and uninstallation of the package."""
     ensure_toml_installed()
     import toml
@@ -32,8 +32,7 @@ def test_package_installation():
     # Check that the package is installed
     result = subprocess.run(
         [sys.executable, "-m", "pip", "show", package_name],
-        stdout=subprocess.PIPE,
-        stderr=subprocess.PIPE,
+        capture_output=True,
         text=True,
     )
     assert result.returncode == 0, "Package installation failed"
@@ -47,8 +46,7 @@ def test_package_installation():
     # Verify the package is uninstalled
     result = subprocess.run(
         [sys.executable, "-m", "pip", "show", package_name],
-        stdout=subprocess.PIPE,
-        stderr=subprocess.PIPE,
+        capture_output=True,
         text=True,
     )
     assert result.returncode != 0, "Package uninstallation failed"

templatepy-0.2.6.dev0.dist-info/RECORD

@@ -1,11 +0,0 @@
-templatepy/__init__.py,sha256=PCKjrSllMfJ1mYtvs2HqZVsSPdyiiXGJAsKmKSSfGB4,160
-templatepy/example.data.file.config,sha256=sRtbLc80ZUpGHm_qaovQ71dXmYf6IVkY8_4Y6YndGms,40
-templatepy/example.data.file.test-extension-yu48,sha256=M3siPvc7bFACsq7uBr3jbN_rd8okgr6051cJcsqPiVw,42
-tests/tests/test_integration/test_placeholder.py,sha256=NYftZ4Oxh0mQUfy3isWQpcbXkw9XCPPoQgll_7Qp_98,836
-tests/tests/test_unit/test_unit.py,sha256=qjQEflbXngqKKkDMpsXWTEAeo6VWeOH8GYBbQDda9cg,1564
-templatepy-0.2.6.dev0.dist-info/LICENSE,sha256=Ew8cEKZj5F51f1JVCmPZAESmeIe0HCdWdlo_NVKD-8s,1522
-templatepy-0.2.6.dev0.dist-info/METADATA,sha256=H8MsZePNpRPcdrPLzjEjmJaSPBOn7X_z98PtM_4w5b8,19882
-templatepy-0.2.6.dev0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-templatepy-0.2.6.dev0.dist-info/entry_points.txt,sha256=AGxmwCmuTD2V6WaG-gZOZq9fu7X-mKRch540WR3b0aY,66
-templatepy-0.2.6.dev0.dist-info/top_level.txt,sha256=LQF8fpEG2Xs3iyqm7StHG8F9Dj-TVPOfcVeky9DtGII,17
-templatepy-0.2.6.dev0.dist-info/RECORD,,