All methods return a request Response (#4)

Author: JohnPreston

.github/workflows/coverage.yaml

@@ -0,0 +1,31 @@
+name: Post coverage comment
+
+on:
+  workflow_run:
+    workflows: ["automated-tests"]
+    types:
+      - completed
+
+jobs:
+  test:
+    name: Run tests & display coverage
+    runs-on: ubuntu-latest
+    if: github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success'
+    permissions:
+      # Gives the action the necessary permissions for publishing new
+      # comments in pull requests.
+      pull-requests: write
+      # Gives the action the necessary permissions for editing existing
+      # comments (to avoid publishing multiple comments in the same PR)
+      contents: write
+      # Gives the action the necessary permissions for looking up the
+      # workflow that launched this workflow, and download the related
+      # artifact that contains the comment to be published
+      actions: read
+    steps:
+
+      - name: Post comment
+        uses: py-cov-action/python-coverage-comment-action@v3
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_PR_RUN_ID: ${{ github.event.workflow_run.id }}

.github/workflows/tests.yml

@@ -7,14 +7,31 @@ jobs:
   pytest:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
-    - uses: actions/setup-python@v4
-      with:
-        python-version: '3.10'
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
 
-    - name: Install dependencies
-      run: |
-        python -m pip install pip -U; python -m pip install poetry; poetry install
-    - name: Run tests
-      run: |
-        pytest -svx
+      - name: Install dependencies
+        run: |
+          python -m pip install pip -U; python -m pip install poetry; poetry install
+
+      - name: Run tests
+        run: |
+          poetry run coverage run --source kafka_schema_registry_admin -m pytest --verbose
+          poetry run coverage report -m
+
+      - name: Coverage comment
+        id: coverage_comment
+        uses: py-cov-action/python-coverage-comment-action@v3
+        with:
+          GITHUB_TOKEN: ${{ github.token }}
+
+      - name: Store Pull Request comment to be posted
+        uses: actions/upload-artifact@v3
+        if: steps.coverage_comment.outputs.COMMENT_FILE_WRITTEN == 'true'
+        with:
+          # If you use a different name, update COMMENT_ARTIFACT_NAME accordingly
+          name: python-coverage-comment-action
+          # If you use a different name, update COMMENT_FILENAME accordingly
+          path: python-coverage-comment-action.txt

.isort.cfg

@@ -1,2 +1,2 @@
 [settings]
-known_third_party = pydantic,pytest,requests,testcontainers
+known_third_party = pytest,requests,testcontainers

.pre-commit-config.yaml

@@ -12,6 +12,8 @@ repos:
       - id: trailing-whitespace
       - id: mixed-line-ending
       - id: detect-aws-credentials
+        args:
+          - "--allow-missing-credentials"
       - id: detect-private-key
       - id: fix-byte-order-marker
 

docs/conf.py

@@ -19,7 +19,8 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('..'))
+
+sys.path.insert(0, os.path.abspath(".."))
 
 import kafka_schema_registry_admin
 
@@ -31,22 +32,22 @@
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode"]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = 'Kafka schema registry admin'
+project = "Kafka schema registry admin"
 copyright = "2021, JohnPreston"
 author = "JohnPreston"
 
@@ -69,10 +70,10 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
@@ -83,7 +84,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = "alabaster"
 
 # Theme options are theme-specific and customize the look and feel of a
 # theme further.  For a list of options available for each theme, see the
@@ -94,13 +95,13 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 
 # -- Options for HTMLHelp output ---------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'kafka_schema_registry_admindoc'
+htmlhelp_basename = "kafka_schema_registry_admindoc"
 
 
 # -- Options for LaTeX output ------------------------------------------
@@ -109,15 +110,12 @@
     # The paper size ('letterpaper' or 'a4paper').
     #
     # 'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     #
     # 'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     #
     # 'preamble': '',
-
     # Latex figure (float) alignment
     #
     # 'figure_align': 'htbp',
@@ -127,9 +125,13 @@
 # (source start file, target name, title, author, documentclass
 # [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'kafka_schema_registry_admin.tex',
-     'Kafka schema registry admin Documentation',
-     'JohnPreston', 'manual'),
+    (
+        master_doc,
+        "kafka_schema_registry_admin.tex",
+        "Kafka schema registry admin Documentation",
+        "JohnPreston",
+        "manual",
+    ),
 ]
 
 
@@ -138,9 +140,13 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'kafka_schema_registry_admin',
-     'Kafka schema registry admin Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "kafka_schema_registry_admin",
+        "Kafka schema registry admin Documentation",
+        [author],
+        1,
+    )
 ]
 
 
@@ -150,13 +156,13 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'kafka_schema_registry_admin',
-     'Kafka schema registry admin Documentation',
-     author,
-     'kafka_schema_registry_admin',
-     'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "kafka_schema_registry_admin",
+        "Kafka schema registry admin Documentation",
+        author,
+        "kafka_schema_registry_admin",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
-
-
-

kafka_schema_registry_admin/client_wrapper/__init__.py

@@ -18,7 +18,7 @@
 class Client:
     """API Client wrapper around the requests"""
 
-    def __init__(self, base_url: str):
+    def __init__(self, base_url: str, basic_auth: dict = None):
         self._base_url = base_url
 
         self._default_headers: dict = {
@@ -28,6 +28,12 @@ def __init__(self, base_url: str):
             "Accept": "application/json",
             "Content-Type": "application/vnd.schemaregistry.v1+json",
         }
+        self.auth = None
+        if basic_auth:
+            self.auth = (
+                basic_auth["basic_auth.username"],
+                basic_auth["basic_auth.password"],
+            )
 
     @evaluate_api_return
     def get(self, api_path: str, *args, **kwargs) -> Response:
@@ -38,7 +44,7 @@ def get(self, api_path: str, *args, **kwargs) -> Response:
         headers.update(self._default_headers)
         url: str = urlparse(self._base_url + api_path).geturl()
 
-        response = requests.get(url, *args, **kwargs)
+        response = requests.get(url, auth=self.auth, *args, **kwargs)
         return response
 
     @evaluate_api_return
@@ -50,8 +56,7 @@ def post(self, api_path: str, *args, **kwargs) -> Response:
         headers.update(self._default_headers)
         headers.update(self._post_headers)
         url: str = urlparse(self._base_url + api_path).geturl()
-        print("URL??", url)
-        response = requests.post(url, *args, **kwargs)
+        response = requests.post(url, auth=self.auth, *args, **kwargs)
         return response
 
     @evaluate_api_return
@@ -63,7 +68,7 @@ def put(self, api_path: str, *args, **kwargs) -> Response:
         headers.update(self._default_headers)
         url: str = urlparse(self._base_url + api_path).geturl()
 
-        response = requests.put(url, *args, **kwargs)
+        response = requests.put(url, auth=self.auth, *args, **kwargs)
         return response
 
     @evaluate_api_return
@@ -75,5 +80,5 @@ def delete(self, api_path: str, *args, **kwargs) -> Response:
         headers.update(self._default_headers)
 
         url: str = urlparse(self._base_url + api_path).geturl()
-        response = requests.delete(url, *args, **kwargs)
+        response = requests.delete(url, auth=self.auth, *args, **kwargs)
         return response