Normalize files (#2334)

* Make python-flake8.yml a general lint workflow

* Add a lint check to prevent crlf endings in git

* Set text=auto and renormalize files

* Add a lint check to prevent whitespace issues

Whitespace issues as understood by git (by default) are trailing
whitespace at EOL, whitespace on an otherwise empty line, a space
character immediately followed by a tab character in the indentation of
a line, and multiple newlines at EOF.

References:
- https://git-scm.com/docs/git-diff#Documentation/git-diff.txt---check
- https://peter.eisentraut.org/blog/2014/11/04/checking-whitespace-with-git

* Fix trailing whitespace issues

* Fix issues with multiple newlines at EOF

* Ignore conflict marker warning in rst files

Author: matrss

.coveragerc

@@ -1,7 +1,7 @@
 [run]
-omit = 
+omit =
      _tests/*
-     */_tests/* 
+     */_tests/*
      mslib/msui/qt5/*
      docs/*
      /tmp/*

.gitattributes

@@ -0,0 +1 @@
+* text=auto

.github/workflows/build_docs_gallery.yml

@@ -1,6 +1,6 @@
 name: Build Gallery
 
-on: 
+on:
    pull_request:
      inputs:
         branch_name:

.github/workflows/lint.yml

@@ -0,0 +1,57 @@
+name: lint
+
+on:
+  push:
+    branches:
+    - develop
+    - stable
+  pull_request:
+    branches:
+    - develop
+    - stable
+
+jobs:
+  flake8:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v3
+      with:
+        python-version: 3.8
+    - name: Lint with flake8
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8
+        flake8 --count --statistics mslib tests
+
+  no-crlf-in-git:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+    - uses: actions/checkout@v4
+    - name: Check for CRLF in the repository
+      run: |
+        files_with_crlf="$(git ls-files --eol | awk '$1 ~ "crlf"')"
+        echo "$files_with_crlf"
+        [ "$files_with_crlf" == "" ] || exit 1
+
+  no-whitespace-issues-in-git:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+    - uses: actions/checkout@v4
+    - name: Check for whitespace issues in the repository
+      # The two example.txt files need to be excluded because whitespace at EOL is part
+      # of their format and they fail to parse otherwise.
+      # The leftover conflict marker warning is ignored for all rst files because
+      # section headings consisting of 7 "=" characters are mistaken to be part of a
+      # conflict marker.
+      run: |
+        issues="$(
+          git diff --check $(git hash-object -t tree /dev/null) HEAD :^tests/data/example.txt :^docs/samples/flight-tracks/example.txt |
+            { grep -v '^.*\.rst:.*leftover conflict marker$' || true; }
+        )"
+        echo "$issues"
+        [ "$issues" == "" ] || exit 1

.github/workflows/python-flake8.yml

@@ -9,24 +9,23 @@ on:
     branches:
     - develop
 
-jobs:     
+jobs:
   test-develop:
-    uses: 
+    uses:
       ./.github/workflows/testing.yml
     with:
       xdist: no
       branch_name: develop
       event_name: ${{ github.event_name }}
-    secrets: 
+    secrets:
       PAT: ${{ secrets.PAT }}
 
   test-develop-xdist:
-    uses: 
+    uses:
       ./.github/workflows/testing.yml
     with:
       xdist: yes
       branch_name: develop
       event_name: ${{ github.event_name }}
     secrets:
       PAT: ${{ secrets.PAT }}
-

.github/workflows/testing-develop.yml

@@ -2,12 +2,12 @@ name: new dependency test (scheduled)
 
 on:
   schedule:
-    - cron: '30 5 * * 1' 
+    - cron: '30 5 * * 1'
 
 
-jobs:     
+jobs:
   test-stable-scheduled:
-    uses: 
+    uses:
       ./.github/workflows/testing.yml
     with:
       xdist: no
@@ -17,14 +17,11 @@ jobs:
       PAT: ${{ secrets.PAT }}
 
   test-develop-scheduled:
-    uses: 
+    uses:
       ./.github/workflows/testing.yml
     with:
       xdist: no
       branch_name: develop
       event_name: ${{ github.event_name }}
     secrets:
       PAT: ${{ secrets.PAT }}
-
-
-

.github/workflows/testing-scheduled.yml

@@ -9,9 +9,9 @@ on:
     - stable
   workflow_dispatch:
 
-jobs:     
+jobs:
   test-stable:
-    uses: 
+    uses:
       ./.github/workflows/testing.yml
     with:
       xdist: no
@@ -21,13 +21,11 @@ jobs:
       PAT: ${{ secrets.PAT }}
 
   test-stable-xdist:
-    uses: 
+    uses:
       ./.github/workflows/testing.yml
     with:
       xdist: yes
       branch_name: stable
       event_name: ${{ github.event_name }}
     secrets:
       PAT: ${{ secrets.PAT }}
-
-

.github/workflows/testing-stable.yml

@@ -24,4 +24,3 @@ build/
 mss.egg-info/
 tutorials/recordings
 tutorials/cursor_image.png
-

.gitignore

@@ -253,7 +253,7 @@ Version 6.2.0
 
 This release includes the use of the new basemap-1.3.3 release and enables packaging for python 3.10.x.
 We added the possibility of flight level as vertical coordinate.
-A user can now leave on his own an operation. 
+A user can now leave on his own an operation.
 
 
 All changes:
@@ -804,7 +804,7 @@ Bug Fixes:
   - mswms crashes on a wms server when the request object is None, #339, #342
   - data_dir not used for default filepicker, #337
   - post_link.sh update on conda-forge, #334
- 
+
 
 Version 1.7.2
 -------------
@@ -1126,7 +1126,7 @@ New Features:
  - Suggest standard name for saving plots, #13
  - KML Overlay introduced for overplot of flight region borders, #61, #97
  - implemented demodata for standalone server and py.test, #80
- - simplified server setup, added demodata. 
+ - simplified server setup, added demodata.
  - Always provide simplified aircraft range estimates in TableView. #85
  - server data needs standard_name in data, #87
  - plugin infrastructure introduced for supporting file formats for flight track saving/loading, #69, #88
@@ -1176,7 +1176,7 @@ Other Changes:
 
 
 
-Version 1.2.2 
+Version 1.2.2
 -------------
 
 Bug Fixes:
@@ -1190,7 +1190,7 @@ New Features:
 Other Changes:
  - installation with conda-forge described#63
 
-Version 1.2.1 
+Version 1.2.1
 -------------
 
 Bug Fixes:
@@ -1223,17 +1223,17 @@ Other Changes:
  - improved documentations
 
 
-Version 1.1.0 
+Version 1.1.0
 -------------
 
 New Features:
  - Vertical section styles supported in standalone server, #10
  - More formats for exchanging flight paths implemented, #7
- - Reverse flight path, #11 
+ - Reverse flight path, #11
  - Displaying model data from CLaMS, #4
  - Visualisation of gravity wave forecasts, #14
  - Improved labels in plots, #8
-   
+
 Bug Fixes:
  - Improved debugging in standalone server, #9
  - Fix for Labels accumulate in plots upon saving, #5
@@ -1243,7 +1243,6 @@ Bug Fixes:
 Other Changes:
  - Namespace refactored, all modules dependend to mslib #24
  - Sphinx documentation introduced, #25, #26
- - Documentation on http://mss.rtfd.io 
- - Installation recipes based on conda  
+ - Documentation on http://mss.rtfd.io
+ - Installation recipes based on conda
  - First public release on June 28, 2016
-