AISDK-184: Implement Link Checker in Python SDK (revdotcom#80)

Author: kshiflett88

.github/workflows/links_fail_fast.yml

@@ -0,0 +1,19 @@
+name: Broken Link Checker
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  linkChecker:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Link Checker
+        uses: lycheeverse/lychee-action@e1ef974431881438bf594f458e332b099fd33bb5 #v1.4.1 https://github.com/lycheeverse/lychee-action#security-tip
+        with:
+          args: --verbose --no-progress './**/*.md' './**/*.html' './**/*.py'
+          fail: true
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

.lycheeignore

@@ -0,0 +1,5 @@
+# API Domain stubs used as url partials in the api clients
+api.rev.ai
+
+# example domains used in unit tests
+example.com

src/rev_ai/baseclient.py

@@ -8,7 +8,7 @@
 
 
 class BaseClient:
-    """Base for clients that communicate with RevAI Apis"""
+    """Base for clients that communicate with Rev AI Apis"""
 
     # Default version of Rev AI
     version = 'v1'

tests/test_utils.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-"""Unit tests for RevAi Utils"""
+"""Unit tests for Rev Ai Utils"""
 
 from src.rev_ai.utils import _process_vocabularies
 from src.rev_ai.models import CustomVocabulary