Merge pull request #43 from ocefpaf/pre-commit

Add pre-commit and modernize code

.github/workflows/tests.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: [ "3.9", "3.10", "3.11" ]
         os: [windows-latest, ubuntu-latest, macos-latest]
       fail-fast: false
 
@@ -37,7 +37,7 @@ jobs:
 
     - name: Test latest compliance-checker
       shell: bash -l {0}
-      if: ${{ (matrix.os == 'ubuntu-latest') && (matrix.python-version == '3.10') }}
+      if: ${{ (matrix.os == 'ubuntu-latest') && (matrix.python-version == '3.11') }}
       run: >
         micromamba remove compliance-checker --yes
         && pip install git+https://github.com/ioos/compliance-checker.git

.gitignore

@@ -12,4 +12,4 @@ env
 
 .DS_Store
 .pytest_cache
-cc_plugin_glider/_version.py
+cc_plugin_glider/_version.py

.pre-commit-config.yaml

@@ -0,0 +1,62 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.5.0
+  hooks:
+    - id: trailing-whitespace
+    - id: check-ast
+    - id: debug-statements
+    - id: end-of-file-fixer
+    - id: check-docstring-first
+    - id: check-added-large-files
+    - id: requirements-txt-fixer
+    - id: file-contents-sorter
+      files: requirements-dev.txt
+
+- repo: https://github.com/psf/black
+  rev: 23.10.0
+  hooks:
+  - id: black
+    language_version: python3
+
+- repo: https://github.com/keewis/blackdoc
+  rev: v0.3.8
+  hooks:
+    - id: blackdoc
+
+- repo: https://github.com/codespell-project/codespell
+  rev: v2.2.6
+  hooks:
+    - id: codespell
+      exclude: >
+          (?x)^(
+              .*\.xml|
+              .*\.cdl
+          )$
+      args:
+        - --ignore-words-list=pres
+
+- repo: https://github.com/asottile/add-trailing-comma
+  rev: v3.1.0
+  hooks:
+    - id: add-trailing-comma
+
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.1.0
+  hooks:
+    - id: ruff
+
+- repo: https://github.com/tox-dev/pyproject-fmt
+  rev: 1.2.0
+  hooks:
+    - id: pyproject-fmt
+
+ci:
+    autofix_commit_msg: |
+        [pre-commit.ci] auto fixes from pre-commit.com hooks
+
+        for more information, see https://pre-commit.ci
+    autofix_prs: false
+    autoupdate_commit_msg: '[pre-commit.ci] pre-commit autoupdate'
+    autoupdate_schedule: monthly
+    skip: []
+    submodules: false

LICENSE.txt

@@ -199,4 +199,3 @@
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
-

README.md

@@ -40,7 +40,7 @@ See the [ioos/compliance-checker](https://github.com/ioos/compliance-checker) fo
 
 
 ## Summary of the Checks
-The checks have been designed to help data providers submit the highest quality data to the GliderDAC. Submitting uncompliant data to the DAC may result in services not working. For example, not providing the correct Sea Name in the GLobal atttributes may put your glider depoyment into the wrong region on the GliderMap. Not providing proper metadata about the platform and instruments, and attribution may prevent NCEI from archiving your data. And not making your files CF compliant could prevent the files from showing up on ERDDAP and THREDDS servers all together.
+The checks have been designed to help data providers submit the highest quality data to the GliderDAC. Submitting uncompliant data to the DAC may result in services not working. For example, not providing the correct Sea Name in the GLobal attributes may put your glider deployment into the wrong region on the GliderMap. Not providing proper metadata about the platform and instruments, and attribution may prevent NCEI from archiving your data. And not making your files CF compliant could prevent the files from showing up on ERDDAP and THREDDS servers all together.
 
 ### High priority checks
 Failures in these checks should be addressed before submitting to the GliderDAC!