Merge pull request #54 from ocefpaf/lints

Lints

.pre-commit-config.yaml

@@ -0,0 +1,72 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.6.0
+  hooks:
+    - id: trailing-whitespace
+      exclude: compliance_checker/tests/data
+    - id: check-ast
+    - id: debug-statements
+    - id: end-of-file-fixer
+      exclude: cc_plugin_ncei/tests/data
+    - id: check-docstring-first
+    - id: check-added-large-files
+    - id: check-json
+    - id: check-merge-conflict
+    - id: check-yaml
+    - id: requirements-txt-fixer
+      args:
+        - requirements.txt
+        - requirements-dev.txt
+
+- repo: https://github.com/keewis/blackdoc
+  rev: v0.3.9
+  hooks:
+    - id: blackdoc
+
+- repo: https://github.com/econchick/interrogate
+  rev: 1.7.0
+  hooks:
+    - id: interrogate
+      exclude: ^(docs|tests)
+      args: [--config=pyproject.toml]
+
+- 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.4.4
+  hooks:
+    - id: ruff
+      args: ["--fix", "--show-fixes"]
+    - id: ruff-format
+
+- repo: https://github.com/tox-dev/pyproject-fmt
+  rev: 2.1.1
+  hooks:
+    - id: pyproject-fmt
+
+- repo: https://github.com/codespell-project/codespell
+  rev: v2.2.6
+  hooks:
+    - id: codespell
+      args:
+        - --ignore-words-list=pres
+      exclude: >
+          (?x)^(
+              .*\.xml|
+              .*\.cdl|
+              .*\.yaml|
+          )$
+
+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

@@ -199,5 +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.
-
-

cc_plugin_ncei/data/seanames.xml

@@ -23,7 +23,7 @@ where sargassum weed is known to collect.  The exact bounding
 box is not currently defined.</definition></seaname><seaname><seaname>Coastal Waters of Florida</seaname><definition>Coastal waters surrounding the state of Florida.</definition></seaname><seaname><seaname>Georges Bank</seaname></seaname><seaname><seaname>Indian River - Florida</seaname></seaname><seaname><seaname>St. Andrew Bay - Florida</seaname></seaname><seaname><seaname>Perdido Bay - Florida/Alabama</seaname></seaname><seaname><seaname>Bering Sea - Norton Sound</seaname><definition>Large embayment on west coast of Alaska.&#13;
 approximately 63-65N, 161.5-165.0W</definition></seaname><seaname><seaname>Coastal Waters of Ireland</seaname></seaname><seaname><seaname>Strait of Magellan</seaname><definition>A body of water separating South America from Tierra del Fuego and other islands to the south of the continent, which connect the Atlantic and Pacific Oceans.</definition></seaname><seaname><seaname>Bo Hai</seaname><definition>Bo Hai may also be identified as Bo Sea, Bohai Sea, Bohai Gulf, Bohai.
 
-According to the IHO Working Group in 2012, the following proposals regarding 'Bo Hai' from China were accepted: 
+According to the IHO Working Group in 2012, the following proposals regarding 'Bo Hai' from China were accepted:
 
 - Proposal: "To consider Bo Hai a separate body from Yellow Sea." Comment: "The following to be inserted in the introductory pages of S-23 (Important Notice): "The limits prescribed in this publication are not IHO endorsements of a coastal State‟s legal position with regard to the Law of the Sea"."
 
@@ -40,7 +40,7 @@ The Irminger Sea was named after Danish vice-admiral Carl Ludvig Christian Irmin
     On the West. A line running westerly from Black Rock Point (50°44',5N) in Vancouver Island through the Scott Islands in such a way that all the narrow waters between these islands are included in the Coastal Waters, thence to Cape St. James (Southern extremity of Queen Charlotte Islands), through this group in the same way, then from Cape Knox (54°10′N 133°06′W) Northward to the Western extreme of Langara Island and on to Point Cornwallis (132°52'W) in the Prince of Wales group, thence along the Western shores of this group, of Baranof, Kruzof, Chicagof, and Yakobi Islands, so that all the narrow waters between them are included in the coastal waters, and, finally, from Cape Bingham (58°04'N) in Yakobi Island to Cape Spencer (58°12′N 136°39′W).  All the narrow waters between the islands in the Scott Islands, the Kerouard Islands, the Queen Charlotte Islands and the Alexander Archipelago, are included in the Coastal Waters.
 Limits of Oceans and Seas, 3rd Ed., 1953.  IHB Special Publication 23, International Hydrographic Bureau, p. 34 at http://www.iho-ohi.net/iho_pubs/standard/S-23/S23_1953.pdf. (Last accessed on 2015-02-10.)
 
-These waterbodies include the Salish Sea (Strait of Juan de Fuca, Puget Sound, Strait of Georgia, and connecting waterbodies), Queen Charlotte Strait, Queen Charlotte Sound, Hecate Strait, Dixon Entrance, Clarence Strait, Sumner Strait, Chatham Strait, Sitka Sound, Frederick Sound, Stephens Passage and Icy Strait. 
+These waterbodies include the Salish Sea (Strait of Juan de Fuca, Puget Sound, Strait of Georgia, and connecting waterbodies), Queen Charlotte Strait, Queen Charlotte Sound, Hecate Strait, Dixon Entrance, Clarence Strait, Sumner Strait, Chatham Strait, Sitka Sound, Frederick Sound, Stephens Passage and Icy Strait.
 
 Wikipedia entry at http://en.wikipedia.org/wiki/Coastal_Waters_of_Southeast_Alaska_and_British_Columbia.  (Last accessed on 2015-02-10.)</definition></seaname><seaname><seaname>Coastal Waters of Louisiana</seaname></seaname><seaname><seaname>Coastal Waters of Mississippi</seaname></seaname><seaname><seaname>Coastal Waters of Texas</seaname></seaname><seaname><seaname>San Diego Bay</seaname><definition>Boundaries defined by NOAA-NOS at http://estuarinebathymetry.noaa.gov/bathy_htmls/P020.html.</definition></seaname><seaname><seaname>Yaquina Bay</seaname><definition>Inland waterway off the Pacific Ocean near the town of Newport Oregon.</definition></seaname><seaname><seaname>Antarctic</seaname><definition>USE Southern Ocean for generic Antarctica sea areas or specific Sea names for named areas</definition></seaname><seaname><seaname>Coastal Waters of British Columbia</seaname><seacode>59B</seacode><definition>This sea area name represents a subset of the IHO defined area called 'Coastal Waters of Southeastern Alaska and British Columbia." No areal extent or bounding limits are officially defined for this sea area at this time (2015).
 
@@ -53,11 +53,11 @@ In the Great Belt: A line joining Gulstav (South extreme of Langeland Island) an
 In Guldborg Sound: A line joining Flinthorne-Rev and Skjelby (54°38' N,11°53' E).
 In the Sound: A line joining Stevns Lighthouse (55°17' N, 12°27' E) and Falsterboe Point (55°23'N, 12°49'E).</definition></seaname><seaname><seaname>East Siberian Sea</seaname><seacode>11</seacode><definition>On the West: The Eastern limit the Laptev Sea (10). On the North: A line from the northernmost point of Wrangel Island (179°30' W) to the northern sides of the De Long Islands (including Henrietta and Jeannette Islands) and Bennett Island, thence to the northern extrmity of Kotelni Island. On the East: From the northernmost point of Wrangel Island through this island to Cape Blossom thence to Cape Yakan on the main land (176°40' E).</definition></seaname><seaname><seaname>Northwestern Passages</seaname><seacode>14</seacode><definition>The limits of the Northwestern Passages, situated between the northern coast of Canada and the off-lying of the Northwest Territories of Canada, are the following: On the North:  From Griffiths Point (76 Degrees 05 Minutes 30 Seconds N - 123 Degrees 01 Minutes W), the western extremity of Prince Patrick Island, northeastward, along the northern coast of this island, to Cape Leopold M Minutes Clintock (77 Degrees 33 Minutes 45 Seconds N - 116 Degrees 24 Minutes W), the northern extremity thereof; thence a line joining Cape Leopold M Minutes Clintock northeastward to Cape Murray (77 Degrees 57 Minutes 45 Seconds N - 115 Degrees 05 Minutes W), the western extremity of Brock Island; thence from Cape Murray northeastward, along the northern coast of this island, to the northern extremity thereof (78 Degrees 04 Minutes 45 Seconds N - 114 Degrees 20 Minutes W); thence a line joining the northern extremity of Brock Island northeastward to Cape Mackay (78 Degrees 21 Minutes N - 113 Degrees 18 Minutes W), the western extremity of Borden Island; thence from Cape Mackay northeastward, along the northern coast of this island, to Cape Malloch (78 Degrees 45 Minutes 30 Seconds N - 110 Degrees 43 Minutes W), the northern extremity thereof; thence a line joining Cape Malloch northeastward to Cape Isachsen (79 Degrees 20 Minutes N - 105 Degrees 26 Minutes W), the northwestern extremity of Ellef Ringnes Island, thence to the northwestern extremity of Meighen Island (80 Degrees 09 Minutes N - 99 Degrees 46 Minutes W), thence to Cape Thomas Hubbard (81 Degrees 22 Minutes N - 94 Degrees 07 Minutes W), the northwestern extremity of Axel Heiberg Island, and thence to Lands Lokk Point (81 Degrees 36 Minutes 30 Seconds N - 91 Degrees 54 Minutes W), the northwestern extremity of Ellesmere Island. On the East:  From Lands Lokk Point southeastward, along the western and southern coasts of Ellesmere Island, to Cape Norton Shaw (76 Degrees 27 Minutes N - 78 Degrees 28 Minutes W), on the southeastern coast of this island; thence a line joining Cape Norton Shaw southward to Phillips Point (76 Degrees 06 Minutes N - 78 Degrees 49 Minutes W), the northeastern extremity of Coburg Island; thence from Phillips Point southward, along the western coast of this island, to the southeastern extremity thereof (75 Degrees 50 Minutes 30 Seconds N - 78 Degrees 55 Minutes W); thence a line joining the southeastern extremity of Coburg Island southwestward to Cape Fitz Roy (75 Degrees 32 Minutes N - 79 Degrees 56 Minutes W), on the northeastern coast of Devon Island; thence from Cape Fitz Roy southward, through Devon Island, to Cape Sherard (74 Degrees 36 Minutes N - 80 Degrees 14 Minutes W), the southeastern extremity of this island; thence a line joining Cape Sherard southeastward to Cape Liverpool (73 Degrees 40 Minutes N - 78 Degrees 05 Minutes W), the northeastern extremity of Bylot Island; thence from Cape Liverpool southeastward, through Bylot Island, to Cape Graham Moore (72 Degrees 52 Minutes N - 76 Degrees 04 Minutes W), the southeastern extremity of this island; thence a line joining Cape Graham Moore southeastward to Cape Macculloch (72 Degrees 29 Minutes 30 Seconds N - 75 Degrees 10 Minutes W), on the northeastern coast of Baffin Island; (the common limit with the Baffin Bay, see 9.12) and thence from Macculloch southward, through Baffin Island, to Lloyd Point (64 Degrees 26 Minutes N - 78 Degrees 02 Minutes W), on the southwestern coast of this island. On the South:  A line joining Lloyd Point southwestward to Seahorse Point (63 Degrees 47 Minutes N - 80 Degrees 09 Minutes W), the eastern extremity of Southampton Island (the common limit with the Hudson Strait, see 9.10); thence from Seahorse northwestward, along the northern coast of Southampton Island, to Cape Munn (65 Degrees 54 Minutes 45 Seconds N - 85 Degrees 31 Minutes 30 Seconds W), the northern extremity of this island; thence a line joining Cape Munn northwestward to Beach Point (66 Degrees 12 Minutes N - 85 Degrees 52 Minutes W), on the coast of Canada (the common limit with the Hudson Bay, see 9.11); and thence from Beach Point westward, along the northern coast of Canada, to Cape Bathurst (70 Degrees 34 Minutes 30 Seconds N - 128 Degrees 02 Minutes W). On the West:  A line joining Cape Bathurst northeastward to Cape Kellett (71 Degrees 58 Minutes N - 126 Degrees 01 Minutes W), the western extremity of Banks Island; thence from Cape Kellett northward, along the western coast of this island, to Cape Prince Alfred (74 Degrees 20 Minutes 30 Seconds N - 124 Degrees 46 Minutes W), the northwestern extremity thereof; and thence a line joining Cape Prince Alfred northward to Griffiths Point (76 Degrees 05 Minutes 30 Seconds N - 123 Degrees 01 Minutes W), the western extremity of Prince Patrick Island (the common limit with the Beaufort Sea, see 9.15).</definition></seaname><seaname><seaname>Japan Sea</seaname><seacode>52</seacode><definition>The limits of the Japan Sea:
 
-On the Southwest: The Northeastern limit of the Eastern China Sea (50) and the Western limit of the Inland Sea (53). 
+On the Southwest: The Northeastern limit of the Eastern China Sea (50) and the Western limit of the Inland Sea (53).
 
 On the Southeast (In Simonoseki Kaikyo): A line running from Nagoya Saki (130°49.5'E) in Kyūshū through the islands of Uma Sima and Muture Sima (33°58.5'N) to Murasaki Hana (34°01' N) in Honsyū.
 
-On the East (In the Tsugaru Kaiko): From the extremity of Siriya Saki (141°28' E) to the extremity of Esan Saki (41°48' N). 
+On the East (In the Tsugaru Kaiko): From the extremity of Siriya Saki (141°28' E) to the extremity of Esan Saki (41°48' N).
 
 On the Northeast (In La Perouse Strait - Soya Kaikyo): A line joining Soni Misaki and Nishi Notaro Misaki (45°55' N).