Merge pull request #298 from JamesParrott/Synced_with_PyShp

Added pre-commit config and ran trailing-whitespace, isort and check-yaml hools
GeospatialPython · Sep 17, 2024 · 89498e4 · 89498e4
2 parents 1c97410 + 677bce0
commit 89498e4
Show file tree

Hide file tree

Showing 10 changed files with 241 additions and 223 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
@@ -7,23 +7,23 @@ body:
     id: pyshp-version
     attributes:
       label: PyShp Version
-      description: Please input the version of PyShp you used. If unsure, call `shapefile.__version__`. 
+      description: Please input the version of PyShp you used. If unsure, call `shapefile.__version__`.
       placeholder: ...
     validations:
       required: true
   - type: input
     id: python-version
     attributes:
       label: Python Version
-      description: Please input the version of the Python executable. 
+      description: Please input the version of the Python executable.
       placeholder: ...
     validations:
       required: true
   - type: textarea
     id: your-code
     attributes:
       label: Your code
-      description: Please copy-paste the relevant parts of your code or script that triggered the error. 
+      description: Please copy-paste the relevant parts of your code or script that triggered the error.
       placeholder: ...
       render: shell
     validations:
@@ -41,7 +41,7 @@ body:
     id: notes
     attributes:
       label: Other notes
-      description: Please input any other notes that may be relevant, e.g. do you have any thoughts on what might be wrong? 
+      description: Please input any other notes that may be relevant, e.g. do you have any thoughts on what might be wrong?
       placeholder: ...
     validations:
       required: false
diff --git a/.github/ISSUE_TEMPLATE/newfeature.yml b/.github/ISSUE_TEMPLATE/newfeature.yml
@@ -15,7 +15,7 @@ body:
     id: contribute
     attributes:
       label: Contributions
-      description: Would you be interested to contribute code that adds this functionality through a Pull Request? We gladly accept PRs - it's much faster and you'll be added a contributor. 
+      description: Would you be interested to contribute code that adds this functionality through a Pull Request? We gladly accept PRs - it's much faster and you'll be added a contributor.
       options:
         - label: I am interested in implementing the described feature request and submit as a PR.
           required: false
diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml
@@ -6,7 +6,7 @@ body:
   - type: textarea
     id: question
     attributes:
-      label: What's your question? 
+      label: What's your question?
       description: Please describe what you would like to know about PyShp, e.g. how to do something.
       placeholder: ...
     validations:

diff --git a/.github/ISSUE_TEMPLATE/unexpected.yml b/.github/ISSUE_TEMPLATE/unexpected.yml
@@ -7,23 +7,23 @@ body:
     id: pyshp-version
     attributes:
       label: PyShp Version
-      description: Please input the version of PyShp you used. If unsure, call `shapefile.__version__`. 
+      description: Please input the version of PyShp you used. If unsure, call `shapefile.__version__`.
       placeholder: ...
     validations:
       required: true
   - type: input
     id: python-version
     attributes:
       label: Python Version
-      description: Please input the version of the Python executable. 
+      description: Please input the version of the Python executable.
       placeholder: ...
     validations:
       required: true
   - type: textarea
     id: your-code
     attributes:
       label: Your code
-      description: Please copy-paste the relevant parts of your code or script that you tried to run. 
+      description: Please copy-paste the relevant parts of your code or script that you tried to run.
       placeholder: ...
       render: shell
     validations:
@@ -48,7 +48,7 @@ body:
     id: notes
     attributes:
       label: Other notes
-      description: Please input any other notes that may be relevant, e.g. do you have any thoughts on what might be wrong? 
+      description: Please input any other notes that may be relevant, e.g. do you have any thoughts on what might be wrong?
       placeholder: ...
     validations:
       required: false
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -10,7 +10,13 @@ on:
   workflow_dispatch:
 
 jobs:
-  build:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+    - uses: pre-commit/action@v3.0.1
+  test:
 
     strategy:
       fail-fast: false

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,12 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v2.3.0
+  hooks:
+    - id: check-yaml
+    - id: trailing-whitespace
+- repo: https://github.com/pycqa/isort
+  rev: 5.13.2
+  hooks:
+    - id: isort
+      name: isort (python)
+
diff --git a/LICENSE.TXT b/LICENSE.TXT
@@ -1,5 +1,5 @@
 The MIT License (MIT)
- 
+
 Copyright � 2013 Joel Lawhead
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the �Software�), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: