Merge pull request #179 from yarikoptic/enh-codespell

Add codespell support (config, workflow) and make it fix some typos

.github/workflows/codespell.yml

@@ -0,0 +1,23 @@
+# Codespell configuration is within setup.cfg
+---
+name: Codespell
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+permissions:
+  contents: read
+
+jobs:
+  codespell:
+    name: Check for spelling errors
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Codespell
+        uses: codespell-project/actions-codespell@v2

.pre-commit-config.yaml

@@ -27,3 +27,9 @@ repos:
     hooks:
     -   id: blacken-docs
         additional_dependencies: [black==19.10b0]
+
+- repo: https://github.com/codespell-project/codespell
+  # Configuration for codespell is in setup.cfg
+  rev: v2.2.6
+  hooks:
+  - id: codespell

setup.cfg

@@ -32,3 +32,10 @@ max_line_length = 88
 [pylama:pylint]
 max_line_length = 88
 disable = R
+
+[codespell]
+# Ref: https://github.com/codespell-project/codespell#using-a-config-file
+skip = .git*,*.svg,data
+check-hidden = true
+# ignore-regex = 
+# ignore-words-list =

src/pyDataverse/api.py

@@ -26,7 +26,7 @@ class Api:
             Base URL of Dataverse instance. Without trailing `/` at the end.
             e.g. `http://demo.dataverse.org`
         api_token : str
-            Authenication token for the api.
+            Authentication token for the api.
 
     Attributes
     ----------

src/pyDataverse/docs/source/user/csv-templates.rst

@@ -32,7 +32,7 @@ The CSV templates are licensed under `CC BY 4.0 <https://creativecommons.org/lic
 Data format
 -----------------------------
 
-- Seperator: ``,``
+- Separator: ``,``
 - Encoding: ``utf-8``
 - Quotation: ``"``. Note: In JSON strings, you have to escape with ``\`` before a quotation mark (e. g. adapt ``"`` to ``\"``).
 - Boolean: we recommend using ``TRUE`` and ``FALSE`` as boolean values. Note: They can be modified, when you open it with your preferred spreadsheet software (e. g. Libre Office), depending on the software or your operating systems settings.

src/pyDataverse/docs/source/user/installation.rst

@@ -7,7 +7,7 @@ Installation
   :local:
 
 There are different options on how to install a Python package, mostly depending
-on your prefered tools and what you want to do with it. The easiest
+on your preferred tools and what you want to do with it. The easiest
 way is in most cases to use pip (see :ref:`below <user_installation_pip>`).
 
 

src/pyDataverse/utils.py

@@ -628,9 +628,9 @@ def save_tree_data(
     filename_df: str = "datafiles.json",
     filename_md: str = "metadata.json",
 ) -> None:
-    """Save lists from data returend by ``dv_tree_walker``.
+    """Save lists from data returned by ``dv_tree_walker``.
 
-    Collect lists of Dataverses, Datasets and Datafiles and save them in seperated JSON files.
+    Collect lists of Dataverses, Datasets and Datafiles and save them in separated JSON files.
 
     Parameters
     ----------

tests/api/test_api.py

@@ -17,7 +17,7 @@
 
 
 class TestApiConnect(object):
-    """Test the NativeApi() class initalization."""
+    """Test the NativeApi() class initialization."""
 
     def test_api_connect(self, native_api):
         sleep(test_config["wait_time"])
@@ -49,7 +49,7 @@ def setup_class(cls):
         cls.dataset_id = None
 
     def test_get_request(self, native_api):
-        """Test successfull `.get_request()` request."""
+        """Test successful `.get_request()` request."""
         # TODO: test params und auth default
         base_url = os.getenv("BASE_URL").rstrip("/")
         query_str = base_url + "/api/v1/info/server"
@@ -59,7 +59,7 @@ def test_get_request(self, native_api):
         assert isinstance(resp, Response)
 
     def test_get_dataverse(self, native_api):
-        """Test successfull `.get_dataverse()` request`."""
+        """Test successful `.get_dataverse()` request`."""
         resp = native_api.get_dataverse(":root")
         sleep(test_config["wait_time"])
 

tests/api/test_upload.py

@@ -80,8 +80,8 @@ def test_file_replacement(self):
         # Act
         with tempfile.TemporaryDirectory() as tempdir:
 
-            orginal = open("tests/data/replace.xyz").read()
-            mutated = "Z" + orginal[1::]
+            original = open("tests/data/replace.xyz").read()
+            mutated = "Z" + original[1::]
             mutated_path = os.path.join(tempdir, "replace.xyz")
 
             with open(mutated_path, "w") as f: