Add codespell: config, workflow (to alert when new typos added) and get typos fixed (#302)

* Add github action to codespell master on push and PRs

* Add rudimentary codespell config

* remove spurious space added in d79fe14

* ignore logs

* [DATALAD RUNCMD] run codespell throughout but ignore fail

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w || :",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^

* [DATALAD RUNCMD] Do interactive fixing of some ambigous typos

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w -i 3 -C 2",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^

Author: yarikoptic

.github/CONTRIBUTING.md

@@ -43,7 +43,7 @@ or using Python's builtin `venv` instead of `virtualenvwrapper`:
 ```
 
 The new environment exists and is activated.
-Now install the development dependencies into that environemt:
+Now install the development dependencies into that environment:
 ```
 (wsgidav_py34) $ pip install -r requirements-dev.txt
 ```

.github/workflows/codespell.yml

@@ -0,0 +1,22 @@
+---
+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@v3
+      - name: Codespell
+        uses: codespell-project/actions-codespell@v2

CHANGELOG.md

@@ -24,7 +24,7 @@
   [symlinks may be a security risk](https://serverfault.com/questions/244592/followsymlinks-on-apache-why-is-it-a-security-risk).<br>
   File resources that are symlinks are still enumerated and listed by the
   directory browser. However trying to access content will raise '403 Forbidden'
-  Pass _follow_symlinks=True_ to the FilesystemProvider constructor or yaml configration
+  Pass _follow_symlinks=True_ to the FilesystemProvider constructor or yaml configuration
   to restore the previous behavior.
 - Add `fs_dav_provider.shadow_map`, which can be used to blend in a favicon
   when context is opened inline (#230)

docs/source/THANKS

@@ -6,7 +6,7 @@ Martin Wendt:
 
 * St�phane Klein for many contributions and testing on Mac
 
-* All other contributers:
+* All other contributors:
   http://code.google.com/p/wsgidav/people/list
   https://github.com/mar10/wsgidav/graphs/contributors
 

docs/source/_templates/autosummary/module.rst

@@ -3,7 +3,7 @@
 ..
   Custom formatting of module doc layout
   https://stackoverflow.com/questions/48074094/use-sphinx-autosummary-recursively-to-generate-api-documentation
-  TODO: how can we add the documented module attribuets (constants, ...)?
+  TODO: how can we add the documented module attributes (constants, ...)?
 
 .. rubric:: Description
 

docs/source/addons-mercurial.rst

@@ -17,7 +17,7 @@ Usage
 -----
 .. note:: This is **not** production code.
 
-To publish a Mercurial repository by the share name 'hg', simply add thes lines
+To publish a Mercurial repository by the share name 'hg', simply add these lines
 to the configuration file::
 
     # Publish a Mercurial repository

docs/source/addons-mysql.rst

@@ -20,7 +20,7 @@ The table's columns are mad accessible as live properties:
 
 Usage
 -----
-To publish an MySQL database, simply add thes lines to the configuration file::
+To publish an MySQL database, simply add these lines to the configuration file::
 
     ### Publish an MySQL 'world' database as share '/world-db'
     from wsgidav.samples.mysql_dav_provider import MySQLBrowserProvider

docs/source/addons-virtual.rst

@@ -28,7 +28,7 @@ contains some virtual files with additional information:
 
 Usage
 -----
-To publish the sample virtual resources, simply add thes lines  to the
+To publish the sample virtual resources, simply add these lines  to the
 configuration file::
 
     # Publish a virtual structure

docs/source/changelog04.md

@@ -83,7 +83,7 @@ Also, the config file is optional, i.e. the server runs also with command line o
 
 <li>
 Property manager<br>
-Removed propertylibrary helper fuctions (only !PropManager class left).<br>
+Removed propertylibrary helper functions (only !PropManager class left).<br>
 Add property functions to davProvider
 getProperties() returns (name, value) tuples, where value is etree.Element
 or HTTPRequestException().<br>

docs/source/development.rst

@@ -93,7 +93,7 @@ committing the changes.  The pull request will then need to be approved before i
 .. note::
 
   Don't mix different topics in a single commit or issue. Instead submit a new pull request (and
-  even create separate branches as apropriate).
+  even create separate branches as appropriate).
 
 
 Setup for Development
@@ -120,7 +120,7 @@ Create and Activate a Virtual Environment
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Virtual environments allow us to develop and test in a sandbox, without affecting our
-system othwerwise. |br|
+system otherwise. |br|
 We need `Python 2.7 <https://www.python.org/downloads/>`_,
 `Python 3.4+ <https://www.python.org/downloads/>`_,
 and `pip <https://pip.pypa.io/en/stable/installing/#do-i-need-to-install-pip>`_ on our system.
@@ -183,7 +183,7 @@ Hack, Hack, Hack
       Since version 3.x source formatting rules are delegated to the
       `Black library <https://black.readthedocs.io/en/stable/>`_.
 
-      Failing tests or not follwing PEP 8 will break builds on
+      Failing tests or not following PEP 8 will break builds on
       `travis <https://app.travis-ci.com/github/mar10/wsgidav>`_ and therefore be
       automatically rejected: