Add new pre commit typos

.editorconfig

@@ -0,0 +1,21 @@
+# Check http://editorconfig.org for more information
+# This is the main config file for this project:
+root = true
+
+[*]
+charset = utf-8
+trim_trailing_whitespace = true
+indent_style = space
+insert_final_newline = true
+
+[*.py]
+indent_size = 4
+
+[*.{bes,bes.mustache}]
+# bes files are XML, but the `actionscript` tag text must use crlf
+end_of_line = crlf
+indent_style = tab
+indent_size = 3
+
+[*.{bat,cmd}]
+end_of_line = crlf

.flake8

@@ -18,3 +18,4 @@ ignore = E127, E128, E203, E265, E266, E402, E501, E722, P207, P208, W503
 exclude =
     .git
     __pycache__
+    examples

.gitconfig

@@ -0,0 +1,6 @@
+[core]
+    hideDotFiles = true
+[rebase]
+    autoStash = true
+[pull]
+    rebase = true

.github/dependabot.yml

@@ -0,0 +1,13 @@
+# Set update schedule for GitHub Actions
+version: 2
+
+# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+updates:
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    # Add assignees
+    assignees:
+      - "jgstew"

.github/workflows/black.yaml

@@ -18,7 +18,7 @@ jobs:
     name: runner / black formatter
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Run black formatter checks
         # https://github.com/rickstaa/action-black
         uses: rickstaa/action-black@v1

.github/workflows/codeql-analysis.yml

@@ -21,7 +21,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL

.github/workflows/flake8.yaml

@@ -20,8 +20,8 @@ jobs:
     name: Python Lint Flake8
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: "3.8"
       - name: Install flake8

.github/workflows/grammar-check.yaml

@@ -0,0 +1,20 @@
+---
+name: grammar-check
+
+on: workflow_dispatch
+
+jobs:
+  grammar-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          target: x86_64-unknown-linux-gnu
+
+      - name: install harper grammar checker
+        run: cargo install --locked --git https://github.com/Automattic/harper.git --branch master --tag v0.23.0 harper-cli
+
+      - name: run harper grammar checker
+        run: harper-cli lint src/besapi/besapi.py

.github/workflows/isort.yaml

@@ -20,8 +20,8 @@ jobs:
     name: runner / isort
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: "3.8"
       - name: Install isort

.github/workflows/misspell.yaml

@@ -9,11 +9,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check out code.
-        uses: actions/checkout@v1
+        uses: actions/checkout@v4
       - name: misspell
         if: ${{ !env.ACT }}
         uses: reviewdog/action-misspell@v1
         with:
           github_token: ${{ secrets.github_token }}
           locale: "US"
-          reporter: github-check  # Change reporter.
+          reporter: github-check # Change reporter.

.github/workflows/pre-commit.yaml

@@ -0,0 +1,17 @@
+---
+name: pre-commit
+
+on: pull_request
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          # requites to grab the history of the PR
+          fetch-depth: 0
+      - uses: actions/setup-python@v5
+      - uses: pre-commit/action@v3.0.1
+        with:
+          extra_args: --color=always --from-ref ${{ github.event.pull_request.base.sha }} --to-ref ${{ github.event.pull_request.head.sha }}

.github/workflows/tag_and_release.yaml

@@ -7,43 +7,47 @@ on:
       - master
     paths:
       - "src/besapi/__init__.py"
-      - ".github/workflows/tag_and_release.yaml"
+      - "src/besapi/besapi.py"
+      # - ".github/workflows/tag_and_release.yaml"
 
 jobs:
   release_new_tag:
     if: github.repository == 'jgstew/besapi'
     name: Tag and Release
     runs-on: ubuntu-latest
     steps:
-      - name: "Checkout source code"
-        uses: "actions/checkout@v1"
+      - name: Checkout source code
+        uses: actions/checkout@v4
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: 3.8
+
+      - name: Install requirements
+        run: if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+
       - name: Read VERSION file
         id: getversion
         run: echo "::set-output name=version::$(python ./setup.py --version)"
+
       # only make release if there is NOT a git tag for this version
       - name: "Check: package version has corresponding git tag"
         # this will prevent this from doing anything when run through ACT
-        if: ${{ !env.ACT }}
+        if: ${{ !env.ACT }} && contains(steps.getversion.outputs.version, '.')
         id: tagged
         shell: bash
         run: git show-ref --tags --verify --quiet -- "refs/tags/v${{ steps.getversion.outputs.version }}" && echo "::set-output name=tagged::0" || echo "::set-output name=tagged::1"
       # wait for all other tests to succeed
       #   what if no other tests?
       - name: Wait for tests to succeed
         if: steps.tagged.outputs.tagged == 1
-        uses: lewagon/wait-on-check-action@v0.2
+        uses: lewagon/wait-on-check-action@v1.3.1
         with:
           ref: master
           running-workflow-name: "Tag and Release"
           repo-token: ${{ secrets.GITHUB_TOKEN }}
           wait-interval: 30
-      - name: Install requirements
-        if: steps.tagged.outputs.tagged == 1
-        run: if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+
       - name: Install build tools
         if: steps.tagged.outputs.tagged == 1
         run: pip install setuptools wheel build
@@ -66,6 +70,6 @@ jobs:
             ${{ steps.getwheelfile.outputs.wheelfile }}
       - name: Publish distribution to PyPI
         if: steps.tagged.outputs.tagged == 1
-        uses: pypa/gh-action-pypi-publish@master
+        uses: pypa/gh-action-pypi-publish@release/v1
         with:
           password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/test_build.yaml

@@ -4,7 +4,8 @@ name: test_build
 on:
   push:
     paths:
-      - "**.py"
+      - "src/**.py"
+      - "tests/**.py"
       - "setup.cfg"
       - "MANIFEST.in"
       - "pyproject.toml"
@@ -13,7 +14,8 @@ on:
       - ".github/workflows/tag_and_release.yaml"
   pull_request:
     paths:
-      - "**.py"
+      - "src/**.py"
+      - "tests/**.py"
       - "setup.cfg"
       - "MANIFEST.in"
       - "pyproject.toml"
@@ -26,42 +28,73 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-latest]
+        os: [ubuntu-latest, windows-latest, macos-13]
         # https://raw.githubusercontent.com/actions/python-versions/main/versions-manifest.json
-        python-version: ["3.6", "3"]
+        python-version: ["3.9", "3"]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
+
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
+
       - name: Install build tools
         run: pip install setuptools wheel build pyinstaller
+
       - name: Install requirements
+        shell: bash
         run: if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+
+      - name: Read VERSION file
+        id: getversion
+        shell: bash
+        run: echo "$(python ./setup.py --version)"
+
       - name: Run Tests - Source
         run: python tests/tests.py
+
+      - name: Test invoke directly src/bescli/bescli.py
+        run: python src/bescli/bescli.py ls logout clear error_count version exit
+
+      - name: Test invoke directly src/besapi/besapi.py
+        run: python src/besapi/besapi.py ls logout clear error_count version exit
+
+      - name: Test invoke directly -m besapi
+        run: cd src && python -m besapi ls logout clear error_count version exit
+
+      - name: Test invoke directly -m bescli
+        run: cd src && python -m bescli ls logout clear error_count version exit
+
       - name: Run build
         run: python3 -m build
+
       - name: Get Wheel File Path
         id: getwheelfile
         shell: bash
         run: echo "::set-output name=wheelfile::$(find "dist" -type f -name "*.whl")"
+
       - name: Test pip install of wheel
         shell: bash
         run: pip install $(find "dist" -type f -name "*.whl")
+
       - name: Test python import besapi
         shell: bash
-        run: python -c "import besapi"
+        run: python -c "import besapi;print(besapi.besapi.__version__)"
+
       - name: Test python import bescli
         shell: bash
-        run: python -c "import bescli"
+        run: python -c "import bescli;bescli.bescli.BESCLInterface().do_version()"
+
       - name: Test python bescli
         shell: bash
         run: python -m bescli ls logout clear error_count version exit
+
       - name: Run Tests - Pip
         run: python tests/tests.py --test_pip
-      - name: Test pyinstaller
+
+      - name: Test pyinstaller build
         run: pyinstaller --clean --collect-all besapi --onefile ./src/bescli/bescli.py
+
       - name: Test bescli binary
         run: ./dist/bescli ls logout clear error_count version exit

.github/workflows/yamllint.yaml

@@ -15,10 +15,10 @@ jobs:
   yamllint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: 3.8
 

.gitignore

@@ -1,5 +1,7 @@
 besapi.conf
 
+tmp/
+
 .DS_Store
 
 # Byte-compiled / optimized / DLL files

.pre-commit-config.yaml

@@ -6,7 +6,7 @@
 # https://github.com/pre-commit/pre-commit-hooks
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.1.0
+    rev: v4.6.0
     hooks:
       - id: check-yaml
       - id: check-json
@@ -27,19 +27,29 @@ repos:
       # - id: no-commit-to-branch
       #   args: [--branch, main]
   - repo: https://github.com/adrienverge/yamllint.git
-    rev: v1.26.3
+    rev: v1.35.1
     hooks:
       - id: yamllint
         args: [-c=.yamllint.yaml]
   - repo: https://github.com/pre-commit/mirrors-isort
     rev: v5.10.1
     hooks:
       - id: isort
-  - repo: https://gitlab.com/pycqa/flake8
-    rev: 3.9.2
-    hooks:
-      - id: flake8
   - repo: https://github.com/psf/black
-    rev: 22.1.0
+    rev: 25.1.0
     hooks:
       - id: black
+  - repo: https://github.com/python-jsonschema/check-jsonschema
+    rev: 0.31.2
+    hooks:
+      - id: check-github-workflows
+        args: ["--verbose"]
+      - id: check-dependabot
+  - repo: meta
+    hooks:
+      - id: check-useless-excludes
+      - id: check-hooks-apply
+  - repo: https://github.com/crate-ci/typos
+    rev: v1.30.0
+    hooks:
+      - id: typos

.pylintrc

@@ -1,5 +1,5 @@
 [MESSAGES CONTROL]
-disable = C0330, C0326, C0103, c-extension-no-member, cyclic-import, no-self-use, unused-argument
+disable = C0103, c-extension-no-member, cyclic-import, no-self-use, unused-argument
 
 [format]
 max-line-length = 88

.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+  "recommendations": [
+    "EditorConfig.EditorConfig",
+    "github.vscode-github-actions",
+    "ms-python.black-formatter",
+    "ms-python.python"
+  ]
+}