Merge pull request #48 from dave3d/RenameScript

Renamed codespell.py to commentspellcheck.py

Author: dave3d

README.md

@@ -8,7 +8,7 @@ It is intended to be run on the SimpleITK and ITK code bases.
 
 Here is how it is typically run:
 
-    python codespell.py --exclude Ancillary $SIMPLEITK_SOURCE_DIR/Code
+    python comment_spell_check.py --exclude Ancillary $SIMPLEITK_SOURCE_DIR/Code
 
 This command will recursively find all the '.h' files in a directory,
 extract the C/C++ comments from the code, and run a spell checker on them.

additional_dictionary.txt

@@ -923,7 +923,6 @@ clientdata
 closedness
 codebook
 codebooks
-codespell
 codeword
 codewords
 codimension

codespell.py renamed to comment_spell_check.py

@@ -317,7 +317,7 @@ def parse_args():
         action="append",
         help="Comma-separated list of files to skip. It "
         "accepts globs as well. E.g.: if you want "
-        "codespell to skip .eps and .txt files, "
+        "coment_spell_check.py to skip .eps and .txt files, "
         'you\'d give "*.eps,*.txt" to this option.'
         " Argument can be passed multiple times.",
     )
@@ -358,9 +358,9 @@ def parse_args():
         help="Set file mime type. File name suffix will be ignored.",
     )
 
-    parser.add_argument(
-        "--version", action="version", version=f"%(prog)s {__version__}"
-    )
+    #    parser.add_argument(
+    #        "--version", action="version", version=f"%(prog)s {__version__}"
+    #    )
 
     args = parser.parse_args()
     return args

pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools>=61.0", "setuptools_scm[toml]>=7.1"]
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "SimpleITKSpellChecking"
+name = "comment_spell_check"
 authors = [
   { name="David Chen", email="[email protected]" },
 ]
@@ -25,7 +25,7 @@ dynamic = ["dependencies", "version"]
 dependencies = {file = ["requirements.txt"]}
 
 [project.scripts]
-codespell = "codespell:main"
+comment_spell_check = "comment_spell_check:main"
 
 [tool.setuptools_scm]
 local_scheme = "dirty-tag"

tests/test_codespell.py renamed to tests/test_comment_spell_check.py

@@ -3,23 +3,23 @@
 import os
 
 
-class TestCodespell(unittest.TestCase):
+class TestCommentSpellCheck(unittest.TestCase):
     @classmethod
     def setUpClass(self):
-        print("\nSetting up codespell tests")
+        print("\nSetting up comment_spell_check tests")
 
     @classmethod
     def tearDownClass(cls):
-        print("\nTearing down dicom2stl tests")
+        print("\nTearing down comment_spell_check tests")
 
-    def test_codespell(self):
-        print("\nCodespell simple test")
+    def test_comment_spell_check(self):
+        print("\nCommand_spell_check simple test")
         cwd = os.getcwd()
         print(cwd)
         runresult = subprocess.run(
             [
                 "python",
-                "codespell.py",
+                "comment_spell_check.py",
                 "--verbose",
                 "--dict",
                 "tests/dict.txt",
@@ -30,15 +30,15 @@ def test_codespell(self):
         )
         print("Return code:", runresult.returncode)
         if runresult.returncode:
-            self.fail("Simple test: codespell process returned bad code")
+            self.fail("Simple test: comment_spell_check.py process returned bad code")
 
-        print("\nCodespell test on itself")
+        print("\nComment_spell_check test on itself")
         cwd = os.getcwd()
         print(cwd)
         runresult = subprocess.run(
             [
                 "python",
-                "codespell.py",
+                "comment_spell_check.py",
                 "--verbose",
                 "--prefix",
                 "myprefix",
@@ -51,4 +51,6 @@ def test_codespell(self):
         )
         print("Return code:", runresult.returncode)
         if runresult.returncode:
-            self.fail("Self code test: codespell process returned bad code")
+            self.fail(
+                "Self code test: comment_spell_check.py process returned bad code"
+            )