diff --git a/.codespellrc b/.codespellrc new file mode 100644 index 0000000..1cd4cac --- /dev/null +++ b/.codespellrc @@ -0,0 +1,6 @@ +[codespell] +# Ref: https://github.com/codespell-project/codespell#using-a-config-file +skip = .git*,.codespellrc +check-hidden = true +# ignore-regex = +# ignore-words-list = diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml new file mode 100644 index 0000000..c59e047 --- /dev/null +++ b/.github/workflows/codespell.yml @@ -0,0 +1,25 @@ +# Codespell configuration is within .codespellrc +--- +name: Codespell + +on: + push: + branches: [main] + pull_request: + branches: [main] + +permissions: + contents: read + +jobs: + codespell: + name: Check for spelling errors + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Annotate locations with typos + uses: codespell-project/codespell-problem-matcher@v1 + - name: Codespell + uses: codespell-project/actions-codespell@v2 diff --git a/README.md b/README.md index 900202f..2969816 100644 --- a/README.md +++ b/README.md @@ -319,9 +319,9 @@ upon setup. ├── MANIFEST.in <- Packaging information for pip ├── README.md <- Description of project which GitHub will render ├── {{repo_name}} <- Basic Python Package import file -│ ├── {{first_module_name}}.py <- Starting packge module +│ ├── {{first_module_name}}.py <- Starting package module │ ├── __init__.py <- Basic Python Package import file -│ ├── _version.py <- Generated file from VersionInGit. Created on package install, not initilization. +│ ├── _version.py <- Generated file from VersionInGit. Created on package install, not initialization. │ ├── data <- Sample additional data (non-code) which can be packaged. Just an example, delete in production │ │   ├── README.md │ │   └── look_and_say.dat @@ -347,7 +347,7 @@ upon setup. │   ├── getting_started.rst │   ├── index.rst │   ├── make.bat -│   └── requirements.yaml <- Documenation building specific requirements. Usually a smaller set than the main program +│   └── requirements.yaml <- Documentation building specific requirements. Usually a smaller set than the main program ├── pyproject.toml <- Generic Python build system configuration (PEP-517). ├── readthedocs.yml ├── setup.cfg <- Near-master config file to make house INI-like settings for Coverage, Flake8, YAPF, etc. diff --git a/hooks/post_gen_project.py b/hooks/post_gen_project.py index e01c6cd..5cafd9a 100644 --- a/hooks/post_gen_project.py +++ b/hooks/post_gen_project.py @@ -10,7 +10,7 @@ def decode_string(string): - """Helper function to covert byte-string to string, but allows normal strings""" + """Helper function to convert byte-string to string, but allows normal strings""" try: return string.decode() except AttributeError: diff --git a/{{cookiecutter.repo_name}}/docs/conf.py b/{{cookiecutter.repo_name}}/docs/conf.py index ab70317..7a58a3f 100644 --- a/{{cookiecutter.repo_name}}/docs/conf.py +++ b/{{cookiecutter.repo_name}}/docs/conf.py @@ -12,7 +12,7 @@ # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -# Incase the project was not installed +# In case the project was not installed import os import sys sys.path.insert(0, os.path.abspath('..'))