Merge pull request #30 from KyleKing/poetry-update

KyleKing · Apr 18, 2024 · 2f8da2e · 2f8da2e
2 parents 55b16c1 + 9f25383
commit 2f8da2e
Show file tree

Hide file tree

Showing 17 changed files with 1,206 additions and 1,415 deletions.
diff --git a/.calcipy_packaging.lock b/.calcipy_packaging.lock
diff --git a/.copier-answers.yml b/.copier-answers.yml
@@ -2,7 +2,7 @@
 # Answer file maintained by Copier for: https://github.com/KyleKing/calcipy_template
 # DO NOT MODIFY THIS FILE. Edit by re-running copier and changing responses to the questions
 # Check into version control.
-_commit: 1.9.5
+_commit: 1.9.13
 _src_path: gh:KyleKing/calcipy_template
 author_email: [email protected]
 author_name: Kyle King

diff --git a/.github/actions/setup/action.yml b/.github/actions/setup/action.yml
@@ -33,7 +33,7 @@ runs:
       shell: bash
 
     - name: Setup Python ${{ inputs.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ inputs.python-version }}
         cache: poetry

diff --git a/.github/workflows/ci_pipeline.yml b/.github/workflows/ci_pipeline.yml
@@ -67,4 +67,4 @@ jobs:
       # Based on: https://github.com/jakebailey/pyright-action/issues/10#issuecomment-1455220629
       - name: Add Poetry Python to Path
         run: echo "$(poetry env info --path)/bin" >> $GITHUB_PATH
-      - uses: jakebailey/pyright-action@v1
+      - uses: jakebailey/pyright-action@v2
diff --git a/.github/workflows/update_docs.yml b/.github/workflows/update_docs.yml
@@ -30,7 +30,7 @@ jobs:
           os: ${{ matrix.os }}
           python-version: ${{ matrix.python-version }}
       - name: Setup Graphviz
-        uses: ts-graphviz/setup-graphviz@v1
+        uses: ts-graphviz/setup-graphviz@v2
 
         # https://github.com/mkdocs/mkdocs/discussions/2369#discussioncomment-625475
       - name: Configure git user

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -40,48 +40,43 @@ repos:
       - id: mixed-line-ending
         args: [--fix=auto]
       - id: trailing-whitespace
+        exclude: __snapshots__/.*\.ambr
   - repo: https://github.com/commitizen-tools/commitizen
-    rev: 3.12.0
+    rev: v3.20.0
     hooks:
       - id: commitizen
   - repo: https://github.com/executablebooks/mdformat
     rev: 0.7.17
     hooks:
       - id: mdformat
-        additional_dependencies: ["mdformat-mkdocs[recommended]>=1.0.6"]
+        additional_dependencies:
+          - "mdformat-mkdocs[recommended]>=2.0.6"
         args: [--wrap=no]
         exclude: _.+\.md|CHANGELOG\.md|CODE_TAG_SUMMARY\.md
   - repo: https://github.com/shellcheck-py/shellcheck-py
-    rev: v0.9.0.6
+    rev: v0.10.0.1
     hooks:
       - id: shellcheck
         args: [--severity=warning]
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: "v3.1.0"
+    rev: "v4.0.0-alpha.8"
     hooks:
       - id: prettier
         additional_dependencies:
           # Note: this version must be the same as the hook revision
-          - "prettier@3.1.0"
+          - "prettier@4.0.0-alpha.8"
           - "prettier-plugin-sh"
         exclude: \.copier-answers\.yml|tests/.*/cassettes/.*\.yaml|tests/data/.*/\.ctt/.*\.ya?ml
         types_or: [html, javascript, json, shell, yaml]
   - repo: https://github.com/adrienverge/yamllint.git
-    rev: v1.33.0
+    rev: v1.35.1
     hooks:
       - id: yamllint
         exclude: tests/.*/cassettes/.*\.yaml
   - repo: https://github.com/pappasam/toml-sort
     rev: v0.23.1
     hooks:
       - id: toml-sort-fix
-        args:
-          [
-            --in-place,
-            --all,
-            --trailing-comma-inline-array,
-            --sort-first=python,
-          ]
         exclude: poetry\.lock
   - repo: https://github.com/MarcoGorelli/absolufy-imports
     rev: v0.3.1
@@ -90,7 +85,7 @@ repos:
         args: [--never]
         files: copier_template_tester/.*\.py
   - repo: https://github.com/KyleKing/calcipy
-    rev: 2.0.2
+    rev: 2.0.4
     hooks:
       - id: copier-forbidden-files
       - id: lint-fix

diff --git a/.ruff.toml b/.ruff.toml
@@ -1,6 +1,10 @@
 # Docs: https://github.com/charliermarsh/ruff
 # Tip: poetry run python -m ruff --explain RUF100
 
+line-length = 120
+target-version = 'py310'
+
+[lint]
 external = [
   'CAC001', # <func> is too complex (8 > 7)
   'ECE001', # Expression is too complex (8 > 7)
@@ -32,18 +36,16 @@ ignore = [
   'TID252', # Relative imports from parent modules are banned
   'TRY003', # Avoid specifying long messages outside the exception class
 ]
-line-length = 120
 preview = true
 select = ['ALL']
-target-version = 'py310'
 unfixable = [
   'ERA001', # Commented out code
 ]
 
-[flake8-quotes]
+[lint.flake8-quotes]
 inline-quotes = 'single'
 
-[flake8-tidy-imports.banned-api]
+[lint.flake8-tidy-imports.banned-api]
 'invoke.collection.Collection'.msg = 'Use calcipy.cli.Collection instead.'
 'invoke.tasks.task'.msg = 'Use calcipy.cli.task instead.'
 'typing.Callable'.msg = 'Use beartype.typing.* instead.'
@@ -53,10 +55,10 @@ inline-quotes = 'single'
 'typing.Protocol'.msg = 'Use beartype.typing.* instead.'
 'typing.TypeVar'.msg = 'Use beartype.typing.* instead.'
 
-[isort]
+[lint.isort]
 known-first-party = ['copier_template_tester']
 
-[per-file-ignores]
+[lint.per-file-ignores]
 './copier_template_tester/../*.py' = [
   'INP001', # File `/<>.py` is part of an implicit namespace package. Add an `__init__.py`.
 ]
@@ -81,5 +83,5 @@ known-first-party = ['copier_template_tester']
   'S101', # Use of `assert` detected
 ]
 
-[pylint]
+[lint.pylint]
 max-args = 6
diff --git a/docs/docs/CHANGELOG.md b/docs/docs/CHANGELOG.md
@@ -1,3 +1,5 @@
+## Unreleased
+
 ## 2.1.1 (2023-11-23)
 
 ### Fix

diff --git a/docs/docs/DEVELOPER_GUIDE.md b/docs/docs/DEVELOPER_GUIDE.md
@@ -49,9 +49,9 @@ poetry config pypi-token.pypi ...
 | `copier_template_tester/__init__.py`            |           17 |         0 |         17 | 100.0%     |
 | `copier_template_tester/_config.py`             |           14 |         0 |          3 | 100.0%     |
 | `copier_template_tester/_pre_commit_support.py` |           13 |         0 |          0 | 94.1%      |
-| `copier_template_tester/_write_output.py`       |           76 |         0 |         13 | 98.0%      |
+| `copier_template_tester/_write_output.py`       |           76 |         0 |         13 | 96.9%      |
 | `copier_template_tester/main.py`                |           30 |         4 |         14 | 86.7%      |
-| **Totals**                                      |          150 |         4 |         47 | 96.1%      |
+| **Totals**                                      |          150 |         4 |         47 | 95.6%      |
 
-Generated on: 2023-12-10
+Generated on: 2024-04-18
 <!-- {cte} -->
diff --git a/docs/docs/STYLE_GUIDE.md b/docs/docs/STYLE_GUIDE.md
@@ -9,51 +9,51 @@ We use [Commitizen](https://github.com/commitizen-tools/commitizen) to manage bo
 > `type(scope): description`
 
 - **Types**
-  - *fix*: A bug fix
-  - *feat*: A new feature
-  - *docs*: Documentation-only changes (code comments, separate docs)
-  - *style*: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons)
-  - *perf*: A code change that improves performance
-  - *refactor*: A change to production code that is not a *fix*, *feat*, or *perf*
-  - *test*: Adding missing or correcting existing tests
-  - *build*: Changes that affect the build system or external dependencies
-  - *ci*: Changes to our CI configuration files and scripts
-  - A `!` can be used to indicate a breaking change (`refactor!: drop support for Node 6`)
-  - **SemVer Rules**
-    - Based on commit type, the version will be auto-incremented: `fix : PATCH // feat : MINOR // BREAKING CHANGE : MAJOR`
+    - *fix*: A bug fix
+    - *feat*: A new feature
+    - *docs*: Documentation-only changes (code comments, separate docs)
+    - *style*: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons)
+    - *perf*: A code change that improves performance
+    - *refactor*: A change to production code that is not a *fix*, *feat*, or *perf*
+    - *test*: Adding missing or correcting existing tests
+    - *build*: Changes that affect the build system or external dependencies
+    - *ci*: Changes to our CI configuration files and scripts
+    - A `!` can be used to indicate a breaking change (`refactor!: drop support for Node 6`)
+    - **SemVer Rules**
+        - Based on commit type, the version will be auto-incremented: `fix : PATCH // feat : MINOR // BREAKING CHANGE : MAJOR`
 - **Scopes**
-  - A Class, File name, Issue Number, other appropriate noun. As examples: `build(poetry): bump requests to v3` or `style(#32): add missing type annotations`
+    - A Class, File name, Issue Number, other appropriate noun. As examples: `build(poetry): bump requests to v3` or `style(#32): add missing type annotations`
 - **Tips**
-  - What if a commit fits multiple types?
-    - Go back and make multiple commits whenever possible. Part of the benefit of Conventional Commits is the focus on more organized and intentional changes
-  - Use `git rebase -i` to fix commit names prior to merging if incorrect types/scopes are used
+    - What if a commit fits multiple types?
+        - Go back and make multiple commits whenever possible. Part of the benefit of Conventional Commits is the focus on more organized and intentional changes
+    - Use `git rebase -i` to fix commit names prior to merging if incorrect types/scopes are used
 
 ### Git Description Guidelines
 
 - [Commit message guidelines](https://writingfordevelopers.substack.com/p/how-to-write-a-commit-message)
-  - Full sentence with verb (*lowercase*) and concise description. Below are modified examples for Conventional Commits
-    - `fix(roles): bug in admin role permissions`
-    - `feat(ui): implement new button design`
-    - `build(pip): upgrade package to remove vulnerabilities`
-    - `refactor: file structure to improve code readability`
-    - `perf(cli): rewrite methods`
-    - `feat(api): endpoints to implement new customer dashboard`
+    - Full sentence with verb (*lowercase*) and concise description. Below are modified examples for Conventional Commits
+        - `fix(roles): bug in admin role permissions`
+        - `feat(ui): implement new button design`
+        - `build(pip): upgrade package to remove vulnerabilities`
+        - `refactor: file structure to improve code readability`
+        - `perf(cli): rewrite methods`
+        - `feat(api): endpoints to implement new customer dashboard`
 - [How to write a good commit message](https://chris.beams.io/posts/git-commit/)
-  - A diff will tell you what changed, but only the commit message can properly tell you why.
-  - Keep in mind: [This](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) [has](https://www.git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines) [all](https://github.com/torvalds/subsurface-for-dirk/blob/master/README.md#contributing) [been](http://who-t.blogspot.co.at/2009/12/on-commit-messages.html) [said](https://github.com/erlang/otp/wiki/writing-good-commit-messages) [before](https://github.com/spring-projects/spring-framework/blob/30bce7/CONTRIBUTING.md#format-commit-messages).
-  - From the seven rules of a great Git commit message:
-    - 2. [Try for 50 characters, but consider 72 the hard limit](https://chris.beams.io/posts/git-commit/#limit-50)
-    - 7. [Use the body to explain what and why vs. how](https://chris.beams.io/posts/git-commit/#why-not-how)
+    - A diff will tell you what changed, but only the commit message can properly tell you why.
+    - Keep in mind: [This](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) [has](https://www.git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines) [all](https://github.com/torvalds/subsurface-for-dirk/blob/master/README.md#contributing) [been](http://who-t.blogspot.co.at/2009/12/on-commit-messages.html) [said](https://github.com/erlang/otp/wiki/writing-good-commit-messages) [before](https://github.com/spring-projects/spring-framework/blob/30bce7/CONTRIBUTING.md#format-commit-messages).
+    - From the seven rules of a great Git commit message:
+        - (2) [Try for 50 characters, but consider 72 the hard limit](https://chris.beams.io/posts/git-commit/#limit-50)
+        - (7) [Use the body to explain what and why vs. how](https://chris.beams.io/posts/git-commit/#why-not-how)
 
 ### Issue Labels and Milestones
 
 Personal Guide
 
-- For Issue Labels, see [labels.yml][labels]
+- For Issue Labels, see \[labels.yml\]\[labels\]
 - Milestones
-  - **Current Tasks**: main milestone (*name could change based on a specific project, sprint, or month*)
-  - **Next Tasks**
-  - **Blue Sky**
+    - **Current Tasks**: main milestone (*name could change based on a specific project, sprint, or month*)
+    - **Next Tasks**
+    - **Blue Sky**
 
 <details>
 <summary>Research</summary>
@@ -127,25 +127,25 @@ Personal Guide
 
 <!-- Revisit -->
 
-- [Git: The Simple Guide][simple_git]
-- [Commit Messages][gcmsg] and [why use the present tense](https://news.ycombinator.com/item?id=8874177)
+- \[Git: The Simple Guide\]\[simple_git\]
+- \[Commit Messages\]\[gcmsg\] and [why use the present tense](https://news.ycombinator.com/item?id=8874177)
 - [GitHub's Advice on GitHub](https://github.com/erlang/otp/wiki/Writing-good-commit-messages)
 - [Most Comprehensive Guide](https://chris.beams.io/posts/git-commit/)
 - [Git Pro Book (free)](https://git-scm.com/book/en/v2)
-  - [Bash Tab-Completion Snippet](https://git-scm.com/book/en/v2/Appendix-A%3A-Git-in-Other-Environments-Git-in-Bash)
+    - [Bash Tab-Completion Snippet](https://git-scm.com/book/en/v2/Appendix-A%3A-Git-in-Other-Environments-Git-in-Bash)
 
 ## Python
 
 <!-- Revisit -->
 
 - Python Style Guides
-  - <https://gist.github.com/sloria/7001839>
-  - <http://www.nilunder.com/blog/2013/08/03/pythonic-sensibilities/>
-  - <https://innoq.github.io/cards42org_en/>
-  - <https://docs.openstack.org/hacking/latest/user/hacking.html#styleguide>
-  - <https://www.python.org/doc/humor/>
-  - <https://docs.python-guide.org/writing/reading/>
-  - <https://realpython.com/python-refactoring/>
+    - <https://gist.github.com/sloria/7001839>
+    - <http://www.nilunder.com/blog/2013/08/03/pythonic-sensibilities/>
+    - <https://innoq.github.io/cards42org_en/>
+    - <https://docs.openstack.org/hacking/latest/user/hacking.html#styleguide>
+    - <https://www.python.org/doc/humor/>
+    - <https://docs.python-guide.org/writing/reading/>
+    - <https://realpython.com/python-refactoring/>
 
 ## ADRs