Upgrade to scaffops/python@65cc40e

Skeleton revision: https://github.com/bswck/skeleton/tree/65cc40e
bswck · Dec 18, 2023 · 5245df6 · 5245df6
1 parent d0c5241
commit 5245df6
Show file tree

Hide file tree

Showing 28 changed files with 207 additions and 159 deletions.
diff --git a/.copier-answers.yml b/.copier-answers.yml
@@ -1,4 +1,4 @@
-_commit: cd034ea
+_commit: 65cc40e
 _src_path: gh:bswck/skeleton
 author_username: bswck
 docs: true

diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -1 +1,3 @@
+# {{'project/.github/#% if author_username == "bswck" %#FUNDING.yml#% endif %#'|skeleton_notice(snref=snref, srev=srev)|custom_indent("# ")}}
+
 github: "bswck"
diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
@@ -1,3 +1,7 @@
+# This file was generated from bswck/skeleton@65cc40e.
+# Instead of changing this particular file, you might want to alter the template:
+# https://github.com/bswck/skeleton/tree/65cc40e/project/.github/ISSUE_TEMPLATE/bug.yml.jinja
+
 # docs https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
 # https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
 

diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -1 +1,5 @@
-blank_issues_enabled: false
+# This file was generated from bswck/skeleton@65cc40e.
+# Instead of changing this particular file, you might want to alter the template:
+# https://github.com/bswck/skeleton/tree/65cc40e/project/.github/ISSUE_TEMPLATE/config.yml.jinja
+
+blank_issues_enabled: true
diff --git a/.github/ISSUE_TEMPLATE/functionality.yaml → .github/ISSUE_TEMPLATE/functionality.yml b/.github/ISSUE_TEMPLATE/functionality.yaml → .github/ISSUE_TEMPLATE/functionality.yml
@@ -1,3 +1,7 @@
+# This file was generated from bswck/skeleton@65cc40e.
+# Instead of changing this particular file, you might want to alter the template:
+# https://github.com/bswck/skeleton/tree/65cc40e/project/.github/ISSUE_TEMPLATE/functionality.yml.jinja
+
 # docs https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
 # https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
 

diff --git a/.github/pull_request_template.md → .github/PULL_REQUEST_TEMPLATE.md b/.github/pull_request_template.md → .github/PULL_REQUEST_TEMPLATE.md
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,6 @@
+version: 2
+updates:
+- package-ecosystem: "gitsubmodule"
+  directory: "/"
+  schedule:
+    interval: "daily"
diff --git a/.github/workflows/documentation-links.yml b/.github/workflows/documentation-links.yml
@@ -1,10 +1,15 @@
+# This file was generated from bswck/skeleton@65cc40e.
+# Instead of changing this particular file, you might want to alter the template:
+# https://github.com/bswck/skeleton/tree/65cc40e/project/.github/workflows/%23%25%20if%20docs%20%25%23documentation-links.yml%23%25%20endif%20%25%23.jinja
+
 name: "readthedocs/actions"
 on:
   pull_request_target:
     types:
     - "opened"
     paths:
     - "docs/**"
+    - "CHANGELOG.md"
 
 permissions:
   pull-requests: "write"

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -1,3 +1,7 @@
+# This file was generated from bswck/skeleton@65cc40e.
+# Instead of changing this particular file, you might want to alter the template:
+# https://github.com/bswck/skeleton/tree/65cc40e/project/.github/workflows/lint.yml.jinja
+
 name: "Lint"
 
 on: ["push"]
@@ -13,6 +17,6 @@ jobs:
         python-version: "3.8"
     - name: "Install Ruff"
       run: |
-        pipx install ruff
+        pip install ruff
     - name: "Analyze the code with Ruff"
       run: "ruff ."
diff --git a/.github/workflows/mypy.yml b/.github/workflows/mypy.yml
@@ -1,3 +1,7 @@
+# This file was generated from bswck/skeleton@65cc40e.
+# Instead of changing this particular file, you might want to alter the template:
+# https://github.com/bswck/skeleton/tree/65cc40e/project/.github/workflows/mypy.yml.jinja
+
 name: "Mypy"
 
 on: ["push"]
@@ -13,7 +17,7 @@ jobs:
         python-version: "3.8"
     - name: "Install the project"
       run: |
-        pipx install poetry
+        pip install poetry
         poetry install
     - name: "Type-check with mypy"
       run: >

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -1,3 +1,7 @@
+# This file was generated from bswck/skeleton@65cc40e.
+# Instead of changing this particular file, you might want to alter the template:
+# https://github.com/bswck/skeleton/tree/65cc40e/project/.github/workflows/%23%25%20if%20publish_on_pypi%20%25%23release.yml%23%25%20endif%20%25%23.jinja
+
 name: "PyPI"
 
 on:

diff --git a/.github/workflows/smokeshow.yml b/.github/workflows/smokeshow.yml
@@ -1,3 +1,7 @@
+# This file was generated from bswck/skeleton@65cc40e.
+# Instead of changing this particular file, you might want to alter the template:
+# https://github.com/bswck/skeleton/tree/65cc40e/project/.github/workflows/%23%25%20if%20public%20%25%23smokeshow.yml%23%25%20endif%20%25%23.jinja
+
 name: "Smokeshow"
 
 on:

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -1,3 +1,7 @@
+# This file was generated from bswck/skeleton@65cc40e.
+# Instead of changing this particular file, you might want to alter the template:
+# https://github.com/bswck/skeleton/tree/65cc40e/project/.github/workflows/%23%25%20if%20test_suite%20%25%23test.yml%23%25%20endif%20%25%23.jinja
+
 name: "Tests"
 
 on: ["push"]
@@ -17,7 +21,7 @@ jobs:
         python-version: "${{matrix.python-version}}"
     - name: "Install the project"
       run: |
-        pipx install poetry
+        pip install poetry
         poetry install
     - name: "Run tests"
       run: "poetry run coverage run -m pytest -v ."

diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,7 @@
+# This file was generated from bswck/skeleton@65cc40e.
+# Instead of changing this particular file, you might want to alter the template:
+# https://github.com/bswck/skeleton/tree/65cc40e/project/.gitignore.jinja
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,11 +1,8 @@
+# This file was generated from bswck/skeleton@65cc40e.
+# Instead of changing this particular file, you might want to alter the template:
+# https://github.com/bswck/skeleton/tree/65cc40e/project/%23%25%20if%20use_precommit%20%25%23.pre-commit-config.yaml%23%25%20endif%20%25%23.jinja
+
 repos:
-- repo: "https://github.com/pre-commit/pre-commit-hooks"
-  rev: "v4.5.0"
-  hooks:
-  - id: "check-yaml"
-    name: "Check YAML files"
-  - id: "trailing-whitespace"
-    name: "Trim trailing whitespaces"
 - repo: "https://github.com/astral-sh/ruff-pre-commit"
   rev: "v0.1.5"
   hooks:
@@ -19,6 +16,10 @@ repos:
 - repo: "https://github.com/python-poetry/poetry"
   rev: "1.7.0"
   hooks:
+  - id: "poetry-lock"
+    stages: ["push"]
+    name: "Run Poetry lock hook"
+    args: ["--no-update"]
   - id: "poetry-check"
     stages: ["push"]
     name: "Run Poetry check hook"
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -1,3 +1,7 @@
+# This file was generated from bswck/skeleton@65cc40e.
+# Instead of changing this particular file, you might want to alter the template:
+# https://github.com/bswck/skeleton/tree/65cc40e/project/%23%25%20if%20docs%20%25%23.readthedocs.yml%23%25%20endif%20%25%23.jinja
+#
 # Read the Docs configuration file
 # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
 version: 2

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,3 +1,8 @@
+<!--
+This file was generated from bswck/skeleton@65cc40e.
+Instead of changing this particular file, you might want to alter the template:
+https://github.com/bswck/skeleton/tree/65cc40e/fragments/contributing.md
+-->
 # Contributing to [runtime_generics](https://github.com/bswck/runtime_generics) 🎉
 Contributions are very welcome. 🚀
 
@@ -25,11 +30,25 @@ If you are proposing a feature:
 -   Remember that this is a volunteer-driven project, and that contributions are
     welcome! ✨
 
-## Get started! 🕹️
+## Pull Request guidelines 📝
+1. Initially mark the PR as a draft, so that the maintainers know that you are making final touches.
+
+1. Ensure that the [test coverage](https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/runtime_generics) is not decreased. If you add a new feature, please add tests for it. [Read more about coverage](https://coverage.readthedocs.io/en/latest/index.html).
+
+1. Ensure that all GitHub checks pass. If they are disabled in your PR, ping the maintainers to request enabling them.
+
+1. Don't forget to link the relevant issue(s) in the PR description and describe the changes you made.
+
+# Get started! 🕹️
 
 Ready to contribute? Here's a quick guide on how to set up runtime_generics and make a change.
 
 
+<!--
+This section was generated from bswck/skeleton@65cc40e.
+Instead of changing this particular file, you might want to alter the template:
+https://github.com/bswck/skeleton/tree/65cc40e/fragments/guide.md
+-->
 
 > [!Note]
 > If you use Windows, it is highly recommended to complete the installation in the way presented below through [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install).
@@ -95,12 +114,3 @@ Ready to contribute? Here's a quick guide on how to set up runtime_generics and
 
 1.  Submit a pull request through the GitHub website.
 
-
-## Pull Request guidelines 📝
-1. Initially mark the PR as a draft, so that the maintainers know that you are making final touches.
-
-1. Ensure that the [test coverage](https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/runtime_generics) is not decreased. If you add a new feature, please add tests for it. [Read more about coverage](https://coverage.readthedocs.io/en/latest/index.html).
-
-1. Ensure that all GitHub checks pass. If they are disabled in your PR, ping the maintainers to request enabling them.
-
-1. Don't forget to link the relevant issue(s) in the PR description and describe the changes you made.
diff --git a/README.md b/README.md
@@ -69,11 +69,9 @@ my_generic.whoami()  # I am MyGeneric[int]
 ```
 
 # Installation
-If you want to…
 
 
 
-## …use this tool in your project 💻
 You might simply install it with pip:
 
 ```shell
@@ -86,8 +84,13 @@ If you use [Poetry](https://python-poetry.org/), then run:
 poetry add runtime-generics
 ```
 
-## …contribute to [runtime_generics](https://github.com/bswck/runtime_generics) 🚀
+## For contributors
 
+<!--
+This section was generated from bswck/skeleton@65cc40e.
+Instead of changing this particular file, you might want to alter the template:
+https://github.com/bswck/skeleton/tree/65cc40e/fragments/guide.md
+-->
 
 > [!Note]
 > If you use Windows, it is highly recommended to complete the installation in the way presented below through [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install).

diff --git a/changes/.gitignore b/changes/.gitignore
@@ -1 +1,5 @@
+# This file was generated from bswck/skeleton@65cc40e.
+# Instead of changing this particular file, you might want to alter the template:
+# https://github.com/bswck/skeleton/tree/65cc40e/project/changes/.gitignore.jinja
+
 !.gitignore
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -1,4 +1,9 @@
 
+<!--
+This file was generated from bswck/skeleton@65cc40e.
+Instead of changing this particular file, you might want to alter the template:
+https://github.com/bswck/skeleton/tree/65cc40e/fragments/contributing.md
+-->
 # Contributing to [runtime_generics](https://github.com/bswck/runtime_generics) 🎉
 Contributions are very welcome. 🚀
 
@@ -26,11 +31,25 @@ If you are proposing a feature:
 -   Remember that this is a volunteer-driven project, and that contributions are
     welcome! ✨
 
-## Get started! 🕹️
+## Pull Request guidelines 📝
+1. Initially mark the PR as a draft, so that the maintainers know that you are making final touches.
+
+1. Ensure that the [test coverage](https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/runtime_generics) is not decreased. If you add a new feature, please add tests for it. [Read more about coverage](https://coverage.readthedocs.io/en/latest/index.html).
+
+1. Ensure that all GitHub checks pass. If they are disabled in your PR, ping the maintainers to request enabling them.
+
+1. Don't forget to link the relevant issue(s) in the PR description and describe the changes you made.
+
+# Get started! 🕹️
 
 Ready to contribute? Here's a quick guide on how to set up runtime_generics and make a change.
 
 
+<!--
+This section was generated from bswck/skeleton@65cc40e.
+Instead of changing this particular file, you might want to alter the template:
+https://github.com/bswck/skeleton/tree/65cc40e/fragments/guide.md
+-->
 
 !!! Note
     If you use Windows, it is highly recommended to complete the installation in the way presented below through [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install).
@@ -96,12 +115,3 @@ Ready to contribute? Here's a quick guide on how to set up runtime_generics and
 
 1.  Submit a pull request through the GitHub website.
 
-
-## Pull Request guidelines 📝
-1. Initially mark the PR as a draft, so that the maintainers know that you are making final touches.
-
-1. Ensure that the [test coverage](https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/runtime_generics) is not decreased. If you add a new feature, please add tests for it. [Read more about coverage](https://coverage.readthedocs.io/en/latest/index.html).
-
-1. Ensure that all GitHub checks pass. If they are disabled in your PR, ping the maintainers to request enabling them.
-
-1. Don't forget to link the relevant issue(s) in the PR description and describe the changes you made.
diff --git a/docs/index.md b/docs/index.md
@@ -11,11 +11,9 @@
 Reuse type arguments explicitly passed at runtime to a generic class before instantiating.
 
 # Installation
-If you want to…
 
 
 
-## …use this tool in your project 💻
 You might simply install it with pip:
 
 ```shell
@@ -28,8 +26,13 @@ If you use [Poetry](https://python-poetry.org/), then run:
 poetry add runtime-generics
 ```
 
-## …contribute to [runtime_generics](https://github.com/bswck/runtime_generics) 🚀
+## For contributors
 
+<!--
+This section was generated from bswck/skeleton@65cc40e.
+Instead of changing this particular file, you might want to alter the template:
+https://github.com/bswck/skeleton/tree/65cc40e/fragments/guide.md
+-->
 
 !!! Note
     If you use Windows, it is highly recommended to complete the installation in the way presented below through [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install).

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,3 +1,7 @@
+# This file was generated from bswck/skeleton@65cc40e.
+# Instead of changing this particular file, you might want to alter the template:
+# https://github.com/bswck/skeleton/tree/65cc40e/project/%23%25%20if%20docs%20%25%23mkdocs.yml%23%25%20endif%20%25%23.jinja
+
 site_name: "runtime_generics"
 site_description: "Reuse type arguments explicitly passed at runtime to a generic class before instantiating."
 site_url: "https://runtime-generics.readthedocs.io/en/latest/"

diff --git a/playground/.gitkeep b/playground/.gitkeep
diff --git a/poetry.lock b/poetry.lock
Original file line number	Diff line number	Diff line change
		@@ -1 +1,3 @@
		# {{'project/.github/#% if author_username == "bswck" %#FUNDING.yml#% endif %#'\|skeleton_notice(snref=snref, srev=srev)\|custom_indent("# ")}}

		github: "bswck"