chore: add spell-checker

.github/labels.yml

@@ -1,7 +1,7 @@
 # GitHub labels are generated automatically with GitHub Labeler
 # Ref: https://github.com/marketplace/actions/github-labeler
 
-# Some labels are adapated from
+# Some labels are adapted from
 # "cookiecutter-hypermodern-python" (MIT License)
 # Ref: https://github.com/cjolowicz/cookiecutter-hypermodern-python/blob/main/%7B%7Bcookiecutter.project_name%7D%7D/.github/labels.yml
 

.pre-commit-config.yaml

@@ -58,6 +58,13 @@ repos:
     - lxml-stubs==0.4.0
     exclude: tests
 
+- repo: https://github.com/crate-ci/typos
+  rev: c3ac9cd9d119e85eb337a6530a52921d5d7907d4  # frozen: v1.16.23
+  hooks:
+  - id: typos
+    args: [--force-exclude] # default is [--write-changes, --force-exclude]
+    exclude: tests/cassettes
+
 - repo: https://github.com/FHPythonUtils/LicenseCheck/
   rev: 15cc02a0c636c5e0caac505d6bfcfd70e17871e9  # frozen: 2023.5.1
   hooks:

docs/credits.md

@@ -1,5 +1,5 @@
 # Credits
 
 - Inspired by the \"for humans approach\" of [requests](http://docs.python-requests.org/en/latest/)
-- [pyoai](https://github.com/infrae/pyoai/) also provided valueable inspiration
+- [pyoai](https://github.com/infrae/pyoai/) also provided valuable inspiration
 - Sickle logo: Free [Valentina typeface](http://pedroarilla.com/en/valentina) by Pedro Arilla and [public domain image](http://commons.wikimedia.org/wiki/File:Sickle_(PSF).png) by Pearson  Foresman.

docs/tutorial.md

@@ -20,7 +20,7 @@ scythe = Scythe("https://zenodo.org/oai2d")
 ## Issuing Requests
 
 oaipmh-scythe provides methods for each of the six OAI verbs (ListRecords,
-GetRecord, Idenitfy, ListSets, ListMetadataFormats, ListIdentifiers).
+GetRecord, Identify, ListSets, ListMetadataFormats, ListIdentifiers).
 
 Start with a ListRecords request:
 

pyproject.toml

@@ -212,3 +212,11 @@ show_error_context = true
 [tool.licensecheck]
 using = "PEP631"
 format = "ansi"
+
+# typos
+# Ref: https://github.com/crate-ci/typos/blob/master/docs/reference.md
+# ------------------------------------------------------------------------------
+
+[tool.typos]
+# add "spellchecker:disable-line" to ignore specific lines
+default.extend-ignore-re = ["(?Rm)^.*# spellchecker:disable-line$"]

tests/unit/test_models.py

@@ -220,7 +220,7 @@ def oai_set(set_element):
 
 def test_set_init(oai_set):
     assert oai_set.setName == "European Middleware Initiative"
-    assert "ser-emi" in oai_set.setSpec
+    assert "ser-emi" in oai_set.setSpec  # spellchecker:disable-line
 
 
 def test_set_repr(oai_set):