templatepy 0.2.7__tar.gz → 0.2.8.dev0__tar.gz

{templatepy-0.2.7 → templatepy-0.2.8.dev0}/.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.2.7
+current_version = 0.2.8.dev0
 commit = True
 tag = False
 tag_name = v{new_version}

templatepy-0.2.8.dev0/.pre-commit-config.yaml

@@ -0,0 +1,20 @@
+# Update versions with: pre-commit autoupdate
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.8.3
+    hooks:
+      # Run the linter.
+      - id: ruff
+        args:
+        - "--fix"
+        - "--show-fixes"
+       # Run the formatter.
+      - id: ruff-format
+
+  # Add mypy for static type checking
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.13.0
+    hooks:
+      - id: mypy
+        additional_dependencies: ["types-toml"]

{templatepy-0.2.7 → templatepy-0.2.8.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: templatepy
-Version: 0.2.7
+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.7"**
+**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
@@ -359,8 +368,9 @@ Easily integrate GitHub CLI into workflows to perform repository tasks. See the
 - 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`

{templatepy-0.2.7 → templatepy-0.2.8.dev0}/README.md

@@ -7,7 +7,10 @@
 
 [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
@@ -28,14 +31,13 @@
 [![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.7"**
+**Version: "0.2.8.dev0"**
 
 
 ## Usage
@@ -76,7 +78,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`**:
@@ -213,7 +215,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:
@@ -245,7 +248,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
@@ -302,8 +311,9 @@ Easily integrate GitHub CLI into workflows to perform repository tasks. See the
 - 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`

templatepy-0.2.8.dev0/pyproject.toml

@@ -0,0 +1,114 @@
+[build-system]
+requires = ["setuptools>=42", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "templatepy"
+version = "0.2.8.dev0"
+authors = [
+    { name = "Lars B. Rollik", email = "L.B.Rollik@protonmail.com" }
+]
+license = { file = "LICENSE" }
+description = "templatepy: Template repo for python repositories & PyPi integration"
+readme = { file = "README.md", content-type = "text/markdown" }
+classifiers = [
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "License :: OSI Approved :: BSD License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+#    "Programming Language :: Python :: 3.12",
+]
+requires-python = ">=3.10"
+dependencies = [
+    "black"
+]
+
+[project.urls]
+Repository = "https://github.com/larsrollik/templatepy"
+"Issue Tracker" = "https://github.com/larsrollik/templatepy/issues"
+
+
+[project.optional-dependencies]
+dev = [
+    "black",
+    "bump2version",
+    "pytest-cov",  # implies: pytest, coverage dependencies
+    "pre-commit",
+    "flake8",
+    "toml",
+]
+
+[project.entry-points.console_scripts]
+templatepy-entrypoint = "templatepy.__init__:run"
+
+[tool.setuptools]
+zip-safe = false
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = [""]
+
+[tool.setuptools.package-data]
+"*" = ["*.config"]
+
+[tool.pytest.ini_options]
+addopts = "--cov=templatepy --cov-report=term-missing --maxfail=5"
+
+[tool.ruff]
+line-length = 88
+indent-width = 4
+include = ["*.pyi"]
+extend-exclude = ["*.eggs", "*.git", "*.hg", "*.mypy_cache", "*.tox", "*.venv", "*_build", "*buck-out", "*build", "*dist"]
+
+[tool.ruff.lint]
+select = [
+    "E",   # Pyflakes (general errors)
+    "W",   # Pycodestyle warnings
+    "F",   # Pyflakes checks (includes unused imports)
+    "I",   # isort (import sorting)
+    "UP",  # pyupgrade (Python syntax upgrades)
+    "YTT", # check for YAML issues
+    "SIM", # detect unnecessary comprehensions, loops, etc.
+    "PTH", # checks for pathlib best practices
+    "TCH",
+    "PYI",
+]
+ignore = []
+
+# Allow fix for all enabled rules (when `--fix`) is provided.
+fixable = ["ALL"]
+unfixable = []
+
+[tool.ruff.format]
+# Like Black, use double quotes for strings.
+quote-style = "double"
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+# Like Black, respect magic trailing commas.
+skip-magic-trailing-comma = false
+# Like Black, automatically detect the appropriate line ending.
+line-ending = "auto"
+
+# Enable auto-formatting of code examples in docstrings. Markdown,
+# reStructuredText code/literal blocks and doctests are all supported.
+#
+# This is currently disabled by default, but it is planned for this
+# to be opt-out in the future.
+docstring-code-format = true
+docstring-code-line-length = "dynamic"
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"  # Accepts: "google", "numpy", or "pep257".
+
+[tool.ruff.lint.per-file-ignores]
+".bumpversion.cfg" = ["E501", "W291", "W292"]  # Equivalent to excluding it from whitespace checks
+
+[tool.mypy]
+# strict = true
+# follow_imports = "silent"
+warn_return_any = false
+ignore_missing_imports = true

templatepy-0.2.8.dev0/templatepy/__init__.py

@@ -0,0 +1,13 @@
+__author__ = "Lars B. Rollik"
+
+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 defined in `pyproject.toml`."""
+    print("Hello, world!")

{templatepy-0.2.7 → templatepy-0.2.8.dev0}/templatepy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: templatepy
-Version: 0.2.7
+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.7"**
+**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
@@ -359,8 +368,9 @@ Easily integrate GitHub CLI into workflows to perform repository tasks. See the
 - 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`

templatepy-0.2.7/.pre-commit-config.yaml

@@ -1,36 +0,0 @@
-# Update versions with: pre-commit autoupdate
-# Check for other available hooks: https://github.com/pre-commit/pre-commit-hooks
-repos:
-  - repo: https://github.com/asottile/reorder_python_imports
-    rev: v3.14.0
-    hooks:
-      - id: reorder-python-imports
-
-  - repo: https://github.com/ambv/black
-    rev: 24.10.0
-    hooks:
-      - id: black
-
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
-    hooks:
-      - id: end-of-file-fixer
-        exclude: '.bumpversion.cfg'
-      - id: trailing-whitespace
-        exclude: '.bumpversion.cfg'
-      - id: check-case-conflict
-      - id: check-merge-conflict
-      - id: check-yaml
-        args: [ '--unsafe' ]
-      - id: debug-statements
-      - id: detect-private-key
-      - id: forbid-new-submodules
-      - id: check-json
-      - id: pretty-format-json
-        args: ['--autofix', '--indent=4', '--no-ensure-ascii']
-      - id: check-added-large-files
-
-  - repo: https://github.com/PyCQA/flake8
-    rev: 7.1.1
-    hooks:
-    -   id: flake8

templatepy-0.2.7/pyproject.toml

@@ -1,86 +0,0 @@
-[build-system]
-requires = ["setuptools>=42", "wheel"]
-build-backend = "setuptools.build_meta"
-
-[project]
-name = "templatepy"
-version = "0.2.7"
-authors = [
-    { name = "Lars B. Rollik", email = "L.B.Rollik@protonmail.com" }
-]
-license = { file = "LICENSE" }
-description = "templatepy: Template repo for python repositories & PyPi integration"
-readme = { file = "README.md", content-type = "text/markdown" }
-classifiers = [
-    "Intended Audience :: Developers",
-    "Topic :: Software Development :: Libraries :: Python Modules",
-    "License :: OSI Approved :: BSD License",
-    "Operating System :: OS Independent",
-    "Programming Language :: Python",
-    "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.10",
-    "Programming Language :: Python :: 3.11",
-#    "Programming Language :: Python :: 3.12",
-]
-requires-python = ">=3.10"
-dependencies = [
-    "black"
-]
-
-[project.urls]
-Repository = "https://github.com/larsrollik/templatepy"
-"Issue Tracker" = "https://github.com/larsrollik/templatepy/issues"
-
-
-[project.optional-dependencies]
-dev = [
-    "black",
-    "bump2version",
-    "pytest-cov",  # implies: pytest, coverage dependencies
-    "pre-commit",
-    "flake8",
-    "toml",
-]
-
-[project.entry-points.console_scripts]
-templatepy-entrypoint = "templatepy.__init__:run"
-
-[tool.setuptools]
-zip-safe = false
-include-package-data = true
-
-[tool.setuptools.packages.find]
-where = [""]
-
-[tool.setuptools.package-data]
-"*" = ["*.config"]
-
-[tool.pytest.ini_options]
-addopts = "--cov=templatepy --cov-report=term-missing --maxfail=5"
-
-[tool.black]
-target-version = ["py310", "py311"]  #, "py312"
-skip-string-normalization = false
-line-length = 79
-include = '\\.pyi?$'
-exclude = '''
-/(
-    \.eggs
-  | \.git
-  | \.hg
-  | \.mypy_cache
-  | \.tox
-  | \.venv
-  | _build
-  | buck-out
-  | build
-  | dist
-)/
-'''
-
-[tool.flake8]
-ignore = ["E203", "E266", "E501", "W503", "F403", "F401"]
-max-line-length = 79
-max-complexity = 18
-select = ["B", "C", "E", "F", "W", "T4", "B9"]
-exclude = ["__init__.py", "build", "__pycache__", ".git", "tests"]

templatepy-0.2.7/templatepy/__init__.py

@@ -1,7 +0,0 @@
-__author__ = "Lars B. Rollik"
-__version__ = "0.2.7"
-
-
-def run():
-    """Example `run` function for entrypoint in `setup.cfg`"""
-    print("Hello, world!")