Merge pull request #24 from darbiadev/release

Release 1.0

Author: shenanigansd

docs/source/conf.py

@@ -1,17 +1,15 @@
-"""Sphinx configuration"""
-
-from __future__ import annotations
-
-# Configuration file for the Sphinx documentation builder.
-# This file only contains a selection of the most common options. For a full
-# list see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
+"""Sphinx configuration file"""
 
 import os
 import sys
 
 import toml
 
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
 sys.path.insert(0, os.path.abspath("../.."))
 
 project_config = toml.load("../../pyproject.toml")
@@ -20,31 +18,22 @@
 git_url: str = project_config["project"]["urls"]["repository"]
 copyright: str = project_config["tool"]["sphinx"]["copyright"]  # noqa: A001
 author: str = project_config["tool"]["sphinx"]["author"]
-api_dir: str = project_config["tool"]["sphinx"]["api_dir"]
 
 # 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.doctest",
     "sphinx.ext.linkcode",
-    "sphinx.ext.autosummary",
-    "sphinx.ext.coverage",
-    "sphinx.ext.todo",
     "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
-    "sphinxcontrib.autoprogram",
+    "autoapi.extension",
 ]
 
-apidoc_module_dir: str = f"../../{api_dir}"
-
 autoapi_type: str = "python"
-autoapi_dirs: list[str] = [apidoc_module_dir]
-
-autosummary_generate: bool = True
+autoapi_dirs: list[str] = ["../../src"]
 
-add_module_names: bool = True
+intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path: list[str] = ["_templates"]
@@ -58,7 +47,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme: str = "sphinx_rtd_theme"
+html_theme: str = "furo"
 
 # 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,
@@ -105,4 +94,4 @@ def linkcode_resolve(domain, info):
         except (OSError, TypeError):
             pass
 
-    return f"{git_url}/blob/main/{filename}"
+    return f"{git_url}/blob/main/src/{filename}"

docs/source/index.rst

@@ -1,20 +1,6 @@
-.. darbiadev-onsite documentation master file, created by
-   sphinx-quickstart on Thu Jul 29 19:22:15 2021.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-Welcome to darbiadev-onsite's documentation!
-============================================
+darbiadev-onsite
+================
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
-
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "darbiadev-onsite"
-version = "0.14.0"
+version = "1.0.0"
 description = "Access OnSite data through FileMaker's JDBC integration"
 authors = [
     { name = "Bradley Reynolds", email = "bradley.reynolds@darbia.dev" },
@@ -9,7 +9,7 @@ license = { text = "MIT" }
 readme = "README.md"
 requires-python = ">=3.9"
 dependencies = [
-    "JayDeBeApi>=1.2.3",
+    "JayDeBeApi",
 ]
 
 [project.urls]
@@ -18,19 +18,18 @@ documentation = "https://docs.darbia.dev/darbiadev-onsite/"
 
 [project.optional-dependencies]
 dev = [
-    "pylint>=2.12.2",
-    "pytest>=6.2.5",
-    "pytest-cov>=3.0.0",
-    "black>=21.12b0",
+    "black",
+    "isort",
+    "pylint",
 ]
 tests = [
-    "pytest>=6.2.5",
+    "pytest",
 ]
 docs = [
-    "sphinx>=4.3.2",
-    "sphinxcontrib-autoprogram>=0.1.7",
-    "sphinx-rtd-theme>=1.0.0",
-    "toml>=0.10.2",
+    "sphinx",
+    "furo",
+    "sphinx-autoapi",
+    "toml",
 ]
 
 [tool.setuptools.package-data]

src/darbiadev_onsite/__init__.py

@@ -1,3 +1,44 @@
 """Access OnSite data through FileMaker's JDBC integration"""
 
-from .lib import OnSiteServices
+from __future__ import annotations
+
+from importlib.resources import files
+
+import jaydebeapi
+
+
+class OnSiteServices:  # pylint: disable=too-few-public-methods
+    """A class wrapping an ODBC connection to OnSite.
+
+    This class wraps an ODBC connection to OnSite.
+    """
+
+    def __init__(self, connection_url: str, username: str, password: str):
+        self._connection_url: str = connection_url
+        self.__username: str = username
+        self.__password: str = password
+
+    def _connect(
+        self,
+    ):
+        return jaydebeapi.connect(
+            "com.filemaker.jdbc.Driver",
+            self._connection_url,
+            [self.__username, self.__password],
+            str(files("darbiadev_onsite").joinpath("vendor/fmjdbc.jar")),
+        )
+
+    def make_query(
+        self,
+        sql: str,
+        parameters: tuple[str | int, ...] | None,
+    ) -> list[dict[str, str | int | float]]:
+        """Make a query to the OnSite DB(s)"""
+        if parameters is None:
+            parameters = ()
+        with self._connect() as connection:
+            cursor = connection.cursor()
+            cursor.execute(sql, parameters)
+
+            columns = [column[0] for column in cursor.description]
+            return [dict(zip(columns, row)) for row in cursor.fetchall()]