1192 add a db class to pyprediktorutilites fixes

README.md

@@ -147,3 +147,17 @@ dwh = Dwh("localhost", "mydatabase", "myusername", "mypassword")
 results = dwh.fetch("SELECT * FROM mytable")
 dwh.execute("INSERT INTO mytable VALUES (1, 'test')")
 ```
+
+# TODOs
+
+1. In `setup.cfg` file there is the following code snipped:
+
+```
+install_requires =
+    pytest
+    pytest-cov
+    pytest-mock
+    pyarrow
+```
+
+Install these packages only when testing and build the documentation via `tox -e docs`. Do not install them on production.

docs/conf.py

@@ -149,6 +149,8 @@
 # If this is True, todo emits a warning for each TODO entries. The default is False.
 todo_emit_warnings = True
 
+# Since the documentation build process doesn't need to make actual database connections, we can mock the pyodbc module during the documentation build.
+autodoc_mock_imports = ["pyodbc"]
 
 # -- Options for HTML output -------------------------------------------------
 
@@ -159,10 +161,10 @@
 # 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
 # documentation.
-#html_theme_options = {
+# html_theme_options = {
 #    "sidebar_width": "300px",
 #    "page_width": "1200px"
-#}
+# }
 
 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = []
@@ -247,7 +249,13 @@
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-    ("index", "user_guide.tex", "pyPrediktorUtilities Documentation", "Andreas Lydersen", "manual")
+    (
+        "index",
+        "user_guide.tex",
+        "pyPrediktorUtilities Documentation",
+        "Andreas Lydersen",
+        "manual",
+    )
 ]
 
 # The name of an image file (relative to this directory) to place at the top of

setup.cfg

@@ -57,7 +57,11 @@ install_requires =
     paramiko >= 3.3.1
     jinja2 >= 3.0.1    
     pandas >= 1.4.4
-    pyodbc >= 4.0.39
+    pyodbc
+    pytest
+    pytest-cov
+    pytest-mock
+    pyarrow
 
 
 [options.packages.find]

tox.ini

@@ -9,6 +9,7 @@ isolated_build = True
 
 
 [testenv]
+sitepackages = True
 description = Invoke pytest to run automated tests
 setenv =
     TOXINIDIR = {toxinidir}
@@ -17,9 +18,9 @@ passenv =
     SETUPTOOLS_*
 extras =
     testing
+allowlist_externals = pytest
 commands =
-    pytest {posargs}
-
+    pytest --show-capture=all {posargs}
 
 # # To run `tox -e lint` you need to make sure you have a
 # # `.pre-commit-config.yaml` file. See https://pre-commit.com