Fix many lint issues

Author: adamtheturtle

.pre-commit-config.yaml

@@ -1,3 +1,5 @@
+fail_fast: true
+
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
 

README.rst

@@ -22,7 +22,10 @@ Getting Started
 
 .. code-block:: python
 
+   """Add a target to VWS and then query it."""
+
    import pathlib
+   import uuid
 
    from vws import VWS, CloudRecoService
 
@@ -39,7 +42,8 @@ Getting Started
        client_access_key=client_access_key,
        client_secret_key=client_secret_key,
    )
-   name = "my_image_name"
+
+   name = "my_image_name_" + uuid.uuid4().hex
 
    image = pathlib.Path("high_quality_image.jpg")
    with image.open(mode="rb") as my_image_file:
@@ -54,6 +58,7 @@ Getting Started
        matching_targets = cloud_reco_client.query(image=my_image_file)
 
    assert matching_targets[0].target_id == target_id
+   a = 1
 
 Full Documentation
 ------------------

docs/source/index.rst

@@ -18,7 +18,10 @@ See the :doc:`api-reference` for full usage details.
 
 .. code-block:: python
 
+   """Add a target to VWS and then query it."""
+
    import pathlib
+   import uuid
 
    from vws import VWS, CloudRecoService
 
@@ -35,9 +38,8 @@ See the :doc:`api-reference` for full usage details.
        client_access_key=client_access_key,
        client_secret_key=client_secret_key,
    )
-   import uuid
 
-   name = "my_image_name" + uuid.uuid4().hex
+   name = "my_image_name_" + uuid.uuid4().hex
 
    image = pathlib.Path("high_quality_image.jpg")
    with image.open(mode="rb") as my_image_file:
@@ -67,11 +69,14 @@ To write unit tests for code which uses this library, without using your Vuforia
 
 .. code-block:: python
 
+   """Test adding a target to VWS."""
+
    import pathlib
 
-   from mock_vws.database import VuforiaDatabase
    from mock_vws import MockVWS
-   from vws import CloudRecoService, VWS
+   from mock_vws.database import VuforiaDatabase
+
+   from vws import VWS, CloudRecoService
 
    with MockVWS() as mock:
        database = VuforiaDatabase()

pyproject.toml

@@ -123,6 +123,11 @@ lint.per-file-ignores."conftest.py" = [
     "S106",
 ]
 
+lint.per-file-ignores."doccmd_*.py" = [
+    # Allow hardcoded secrets in documentation.
+    "S105",
+]
+
 lint.per-file-ignores."tests/*.py" = [
     # Do not require tests to have a one-line summary.
     "D205",