release new version

pything · Aug 15, 2024 · 215658f · 215658f
1 parent f6011e8
commit 215658f
Show file tree

Hide file tree

Showing 530 changed files with 2,439 additions and 2,013 deletions.
diff --git a/.conda/meta.yaml b/.conda/meta.yaml
@@ -1,5 +1,5 @@
-{ % set name = "draugr" % }
-  { % set version = "1.0" % }
+{% set name = "draugr" %}
+{% set version = "1.0" %}
 
 package:
   name: "{{ name|lower }}"

diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md
@@ -2,9 +2,12 @@
 
 ## Our Pledge
 
-In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making
-participation in our project and our community a harassment-free experience for everyone, regardless of age, body size,
-disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race,
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to
+making
+participation in our project and our community a harassment-free experience for everyone, regardless of age,
+body size,
+disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance,
+race,
 religion, or sexual identity and orientation.
 
 ## Our Standards
@@ -27,28 +30,38 @@ Examples of unacceptable behavior by participants include:
 
 ## Our Responsibilities
 
-Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to
+take
 appropriate and fair corrective action in response to any instances of unacceptable behavior.
 
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits,
-issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki
+edits,
+issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any
 contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
 
 ## Scope
 
-This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the
-project or its community. Examples of representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed representative at an online or offline
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing
+the
+project or its community. Examples of representing a project or community include using an official project
+e-mail
+address, posting via an official social media account, or acting as an appointed representative at an online or
+offline
 event. Representation of a project may be further defined and clarified by project maintainers.
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at
-[email protected]. The project team will review and investigate all complaints, and will respond in a way
-that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project
+team at
+[email protected]. The project team will review and investigate all complaints, and will respond in
+a way
+that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with
+regard to
 the reporter of an incident. Further details of specific enforcement policies may be posted separately.
 
-Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or
+permanent
 repercussions as determined by other members of the project's leadership.
 
 ## Attribution

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -8,7 +8,8 @@ We welcome pull requests.
 
 ## Issues
 
-We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be
+We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient
+instructions to be
 able to reproduce the issue.
 
 ## Coding Style
@@ -17,5 +18,6 @@ able to reproduce the issue.
 
 ## License
 
-By contributing to [Draugr](https://github.com/cnheider/draugr), you agree that your contributions will be licensed
+By contributing to [Draugr](https://github.com/cnheider/draugr), you agree that your contributions will be
+licensed
 under the LICENSE file in the root directory of this repository.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,52 +1,62 @@
 fail_fast: true
-#exclude: '^exclude'
 repos:
-  - repo: https://github.com/psf/black
-    rev: 24.2.0
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.17.0
+    hooks:
+      - id: pyupgrade
+        args:
+          - --py38-plus
+          - --keep-runtime-typing
+
+  - repo: https://github.com/ambv/black
+    rev: 24.8.0
     hooks:
       - id: black
         language_version: python3.10
-  - repo: local
-    hooks:
-      - id: flake8-check1 # stop the build if there are Python syntax errors or undefined names
-        name: flake8-check1
-        entry: flake8 draugr --count --select=E9,F63,F7,F82 --show-source --statistics --exclude=*exclude*
-        language: system
-        pass_filenames: false
-        always_run: true
-  - repo: local
+
+  - repo: https://github.com/abravalheri/validate-pyproject
+    rev: v0.19
     hooks:
-      - id: flake8-check2 # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        name: flake8-check2
-        entry: flake8 draugr --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics --exclude=*exclude*
-        language: system
-        pass_filenames: false
-        always_run: true
+      - id: validate-pyproject
+
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.7.0
+    rev: v1.11.1
     hooks:
       - id: mypy
         verbose: true
         #exclude: ^tests/
         entry: bash -c 'mypy "$@" || true' -- # only print
         #args: [ --strict ]
-  #  - repo: local
-  #    hooks:
-  #      - id: sphinx-check
-  #        name: sphinx-check
-  #        entry: docs/make.sh
-  #        language: script
-  #        types: [ python ]
-  #        pass_filenames: false
 
-  #  - repo: local
-  #    hooks:
-  #      - id: pytest-check
-  #        name: pytest-check
-  #        entry: pytest
-  #        language: system
-  #        pass_filenames: false
-  #        always_run: true
+  - repo: https://github.com/pycqa/flake8
+    rev: 7.1.1 # pick a git hash / tag to point to
+    hooks:
+      - id: flake8 # stop the build if there are Python syntax errors or undefined names
+        additional_dependencies: [flake8-docstrings]
+        exclude: ^exclude*
+        args:
+          - --count
+          - --select=E9,F63,F7,F82
+          - --show-source
+          - --statistics
+      - id: flake8 # only warn
+        additional_dependencies: [flake8-docstrings]
+        exclude: ^exclude*
+        args:
+          - --count
+          - --exit-zero
+          - --max-complexity=10
+          - --max-line-length=127
+          - --statistics
+
+  - repo: local
+    hooks:
+      - id: pytest-check
+        name: pytest-check
+        entry: pytest
+        language: system
+        pass_filenames: false
+        always_run: true
 
   #  - repo: local
   #    hooks:
@@ -120,11 +130,11 @@ repos:
   #          )$
 
   # Prettier
-#  - repo: https://github.com/pre-commit/mirrors-prettier
-#    rev: v3.1.0
-#    hooks:
-#      - id: prettier
-#        types: [yaml]
+  #- repo: https://github.com/pre-commit/mirrors-prettier
+  #  rev: v4.0.0-alpha.8
+  #  hooks:
+  #    - id: prettier
+  #      types: [yaml]
 
   #  - repo: https://github.com/jsh9/pydoclint
   #    rev: 0.3.8
@@ -138,7 +148,7 @@ repos:
   #          ]
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0 # Use the ref you want to point at
+    rev: v4.6.0 # Use the ref you want to point at
     hooks:
       - id: check-added-large-files
         name: check for added large files
@@ -174,26 +184,26 @@ repos:
         entry: check-docstring-first
         language: python
         types: [python]
-      #      - id: check-executables-have-shebangs
-      #        name: check that executables have shebangs
-      #        description: ensures that (non-binary) executables have a shebang.
-      #        entry: check-executables-have-shebangs
-      #        language: python
-      #        types: [text, executable]
-      #        stages: [commit, push, manual]
-      #      - id: check-shebang-scripts-are-executable
-      #        name: check that scripts with shebangs are executable
-      #        description: ensures that (non-binary) files with a shebang are executable.
-      #        entry: check-shebang-scripts-are-executable
-      #        language: python
-      #        types: [ text ]
-      #        stages: [ commit, push, manual ]
+      - id: check-executables-have-shebangs
+        name: check that executables have shebangs
+        description: ensures that (non-binary) executables have a shebang.
+        entry: check-executables-have-shebangs
+        language: python
+        types: [text, executable]
+        stages: [commit, push, manual]
       - id: check-json
         name: check json
         description: checks json files for parseable syntax.
         entry: check-json
         language: python
         types: [json]
+      - id: check-shebang-scripts-are-executable
+        name: check that scripts with shebangs are executable
+        description: ensures that (non-binary) files with a shebang are executable.
+        entry: check-shebang-scripts-are-executable
+        language: python
+        types: [text]
+        stages: [commit, push, manual]
       - id: pretty-format-json
         name: pretty format json
         description: sets a standard for formatting json files.
@@ -248,12 +258,24 @@ repos:
         entry: destroyed-symlinks
         language: python
         types: [file]
+      #- id: detect-aws-credentials
+      #  name: detect aws credentials
+      #  description: detects *your* aws credentials from the aws cli credentials file.
+      #  entry: detect-aws-credentials
+      #  language: python
+      #  types: [ text ]
       - id: detect-private-key
         name: detect private key
         description: detects the presence of private keys.
         entry: detect-private-key
         language: python
         types: [text]
+      #- id: double-quote-string-fixer
+      #  name: fix double quoted strings
+      #  description: replaces double quoted strings with single quoted strings.
+      #  entry: double-quote-string-fixer
+      #  language: python
+      #  types: [ python ]
       - id: end-of-file-fixer
         name: fix end of files
         description: ensures that a file is either empty, or ends with one newline.
@@ -273,12 +295,6 @@ repos:
         entry: fix-byte-order-marker
         language: python
         types: [text]
-      - id: fix-encoding-pragma
-        name: fix python encoding pragma
-        description: "adds # -*- coding: utf-8 -*- to the top of python files."
-        language: python
-        entry: fix-encoding-pragma
-        types: [python]
       - id: forbid-new-submodules
         name: forbid new submodules
         description: prevents addition of new git submodules.