mapepire-python 0.3.0__tar.gz → 0.3.1__tar.gz

{mapepire_python-0.3.0 → mapepire_python-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mapepire-python
-Version: 0.3.0
+Version: 0.3.1
 Author-email: Adam Shedivy <adam.shedivy@ibm.com>, Irfan Sharif <IrfanSharif@ibm.com>
 License:                                  Apache License
                                    Version 2.0, January 2004
@@ -219,11 +219,14 @@ License-File: LICENSE
 Requires-Dist: dataclasses-json>=0.6.4
 Requires-Dist: websockets>=14.0
 Requires-Dist: pep249abc
+Provides-Extra: kerberos
+Requires-Dist: gssapi; sys_platform != "win32" and extra == "kerberos"
+Requires-Dist: pywin32; sys_platform == "win32" and extra == "kerberos"
 Provides-Extra: dev
-Requires-Dist: ruff; extra == "dev"
-Requires-Dist: mypy<1.20,>=1.0; extra == "dev"
+Requires-Dist: ruff<0.16,>=0.15; extra == "dev"
+Requires-Dist: mypy<2.4,>=1.0; extra == "dev"
 Requires-Dist: black<27.0,>=24.3.0; extra == "dev"
-Requires-Dist: isort<6.2,>=5.12; extra == "dev"
+Requires-Dist: isort<8.1,>=5.12; extra == "dev"
 Requires-Dist: pytest>=9.0.3; extra == "dev"
 Requires-Dist: pep249abc; extra == "dev"
 Requires-Dist: pytest-asyncio; extra == "dev"
@@ -236,8 +239,6 @@ Requires-Dist: packaging; extra == "dev"
 Requires-Dist: pre-commit; extra == "dev"
 Requires-Dist: python-dotenv; extra == "dev"
 Requires-Dist: pytest-env; extra == "dev"
-Requires-Dist: gssapi; extra == "dev"
-Requires-Dist: pywin32; sys_platform == "win32" and extra == "dev"
 Dynamic: license-file
 
 # mapepire-python
@@ -261,6 +262,7 @@ Dynamic: license-file
   - [Overview](#overview)
   - [Setup](#setup)
     - [Install with `pip`](#install-with-pip)
+      - [Optional: Kerberos authentication support](#optional-kerberos-authentication-support)
     - [Server Component Setup](#server-component-setup)
 - [Quick Start](#quick-start)
 - [Other Connection options](#other-connection-options)
@@ -332,6 +334,23 @@ Dynamic: license-file
 pip install mapepire-python
 ```
 
+#### Optional: Kerberos authentication support
+
+Kerberos authentication (see [Authenticating with Kerberos](#11-authenticating-with-kerberos)) requires the optional `kerberos` extra, which pulls in `gssapi` on Linux/macOS or `pywin32` on Windows:
+
+```bash
+pip install mapepire-python[kerberos]
+```
+
+On Linux, building `gssapi` also requires Kerberos development headers to be available, e.g.:
+
+```bash
+sudo apt install libkrb5-dev      # Debian/Ubuntu
+sudo dnf install krb5-devel       # Fedora/RHEL
+```
+
+If you don't use Kerberos authentication, you don't need this extra — the base `pip install mapepire-python` has no Kerberos dependencies.
+
 ### Server Component Setup
 To use mapire-python, you will need to have the Mapepire Server Component running on your IBM i server. Follow these instructions to set up the server component: [Mapepire Server Installation](https://mapepire-ibmi.github.io/guides/sysadmin/)
 
@@ -404,6 +423,9 @@ job = SQLJob(creds)
 ### 1.1 Authenticating with Kerberos
 If your IBM i is configured to support Kerberos authentication, you can authenticate using Kerberos instead of passing a plain-text password to the `DaemonServer` Object.
 
+> [!NOTE]
+> Kerberos support requires the `kerberos` extra: `pip install mapepire-python[kerberos]`. See [Optional: Kerberos authentication support](#optional-kerberos-authentication-support).
+
 #### 1.1.1 Windows
 
 If your Windows machine is part of a Kerberos realm and supports SSPI authentication, you can authenticate by creating the `DaemonServer` as shown below:
@@ -486,12 +508,14 @@ First create a `mapepire.ini` file in the root of your project with the followin
 
 ```ini title=mapepire.ini
 [mapepire]
-SERVER="SERVER"
-PORT="PORT"
-USER="USER"
-PASSWORD="PASSWORD"
+host=SERVER
+port=PORT
+user=USER
+password=PASSWORD
 ```
 
+> **Note:** The keys must match the `DaemonServer` fields (`host`, `port`, `user`, `password`), and values must **not** be quoted — write `host=myhost`, not `host="myhost"`.
+
 Then you can create a `SQLJob` object by passing the path to the `.ini` file which will handle the connection details
 
 
@@ -573,7 +597,7 @@ logging.getLogger("mapepire_python").setLevel(logging.DEBUG)
 
 # Usage
 
-Depending on your setup and use case, you can choose the most convenient way to configure the connection details. The following usage examples are compatible with all three connection options detailed above. For simplicity, we assume there is a `mapepire.ini` file in the root of the project with the connection details.
+Depending on your setup and use case, you can choose the most convenient way to configure the connection details. The following usage examples are compatible with all four connection options detailed above. For simplicity, we assume there is a `mapepire.ini` file in the root of the project with the connection details.
 
 
 There are four main ways to run queries using `mapepire-python`:

{mapepire_python-0.3.0 → mapepire_python-0.3.1}/README.md

@@ -19,6 +19,7 @@
   - [Overview](#overview)
   - [Setup](#setup)
     - [Install with `pip`](#install-with-pip)
+      - [Optional: Kerberos authentication support](#optional-kerberos-authentication-support)
     - [Server Component Setup](#server-component-setup)
 - [Quick Start](#quick-start)
 - [Other Connection options](#other-connection-options)
@@ -90,6 +91,23 @@
 pip install mapepire-python
 ```
 
+#### Optional: Kerberos authentication support
+
+Kerberos authentication (see [Authenticating with Kerberos](#11-authenticating-with-kerberos)) requires the optional `kerberos` extra, which pulls in `gssapi` on Linux/macOS or `pywin32` on Windows:
+
+```bash
+pip install mapepire-python[kerberos]
+```
+
+On Linux, building `gssapi` also requires Kerberos development headers to be available, e.g.:
+
+```bash
+sudo apt install libkrb5-dev      # Debian/Ubuntu
+sudo dnf install krb5-devel       # Fedora/RHEL
+```
+
+If you don't use Kerberos authentication, you don't need this extra — the base `pip install mapepire-python` has no Kerberos dependencies.
+
 ### Server Component Setup
 To use mapire-python, you will need to have the Mapepire Server Component running on your IBM i server. Follow these instructions to set up the server component: [Mapepire Server Installation](https://mapepire-ibmi.github.io/guides/sysadmin/)
 
@@ -162,6 +180,9 @@ job = SQLJob(creds)
 ### 1.1 Authenticating with Kerberos
 If your IBM i is configured to support Kerberos authentication, you can authenticate using Kerberos instead of passing a plain-text password to the `DaemonServer` Object.
 
+> [!NOTE]
+> Kerberos support requires the `kerberos` extra: `pip install mapepire-python[kerberos]`. See [Optional: Kerberos authentication support](#optional-kerberos-authentication-support).
+
 #### 1.1.1 Windows
 
 If your Windows machine is part of a Kerberos realm and supports SSPI authentication, you can authenticate by creating the `DaemonServer` as shown below:
@@ -244,12 +265,14 @@ First create a `mapepire.ini` file in the root of your project with the followin
 
 ```ini title=mapepire.ini
 [mapepire]
-SERVER="SERVER"
-PORT="PORT"
-USER="USER"
-PASSWORD="PASSWORD"
+host=SERVER
+port=PORT
+user=USER
+password=PASSWORD
 ```
 
+> **Note:** The keys must match the `DaemonServer` fields (`host`, `port`, `user`, `password`), and values must **not** be quoted — write `host=myhost`, not `host="myhost"`.
+
 Then you can create a `SQLJob` object by passing the path to the `.ini` file which will handle the connection details
 
 
@@ -331,7 +354,7 @@ logging.getLogger("mapepire_python").setLevel(logging.DEBUG)
 
 # Usage
 
-Depending on your setup and use case, you can choose the most convenient way to configure the connection details. The following usage examples are compatible with all three connection options detailed above. For simplicity, we assume there is a `mapepire.ini` file in the root of the project with the connection details.
+Depending on your setup and use case, you can choose the most convenient way to configure the connection details. The following usage examples are compatible with all four connection options detailed above. For simplicity, we assume there is a `mapepire.ini` file in the root of the project with the connection details.
 
 
 There are four main ways to run queries using `mapepire-python`:

{mapepire_python-0.3.0 → mapepire_python-0.3.1}/mapepire_python/authentication/kerberosTokenProvider.py

@@ -6,17 +6,13 @@ from typing import Final, Optional
 
 logger = logging.getLogger(__name__)
 
-sspi = None
-gssapi = None
 PLATFORM = platform.system()
 TOKEN_PREFIX: Final = "_KERBEROSAUTH_"
 
-
-# For Windows SSPI token generation:
-if PLATFORM == "Windows":
-    import sspi
-else:
-    import gssapi
+_KERBEROS_EXTRA_HINT = (
+    "Kerberos authentication requires the optional 'kerberos' extra. "
+    "Install it with: pip install mapepire-python[kerberos]"
+)
 
 
 class KerberosTokenProvider:
@@ -62,6 +58,11 @@ class KerberosTokenProvider:
         return TOKEN_PREFIX + token_b64
 
     def _refresh_token_windows(self) -> str:
+        try:
+            import sspi
+        except ImportError as e:
+            raise ImportError(_KERBEROS_EXTRA_HINT) from e
+
         logger.debug("Generating Kerberos token via Windows SSPI for host=%s", self.host)
         target = f"krbsvr400/{self.host}"
         client = sspi.ClientAuth("Kerberos", targetspn=target)
@@ -76,6 +77,11 @@ class KerberosTokenProvider:
         return self._format_token(token)
 
     def _refresh_token_unix(self) -> str:
+        try:
+            import gssapi
+        except ImportError as e:
+            raise ImportError(_KERBEROS_EXTRA_HINT) from e
+
         logger.debug("Generating Kerberos token via GSSAPI for host=%s realm=%s", self.host, self.realm)
         os.environ["KRB5_CONFIG"] = self.krb5_path
         if self.ticket_cache:

{mapepire_python-0.3.0 → mapepire_python-0.3.1}/mapepire_python/version.py

@@ -2,7 +2,7 @@ _MAJOR = "0"
 _MINOR = "3"
 # On main and in a nightly release the patch should be one ahead of the last
 # released build.
-_PATCH = "0"
+_PATCH = "1"
 # This is mainly for nightly builds which have the suffix ".dev$DATE". See
 # https://semver.org/#is-v123-a-semantic-version for the semantics.
 _SUFFIX = ""

{mapepire_python-0.3.0 → mapepire_python-0.3.1}/mapepire_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mapepire-python
-Version: 0.3.0
+Version: 0.3.1
 Author-email: Adam Shedivy <adam.shedivy@ibm.com>, Irfan Sharif <IrfanSharif@ibm.com>
 License:                                  Apache License
                                    Version 2.0, January 2004
@@ -219,11 +219,14 @@ License-File: LICENSE
 Requires-Dist: dataclasses-json>=0.6.4
 Requires-Dist: websockets>=14.0
 Requires-Dist: pep249abc
+Provides-Extra: kerberos
+Requires-Dist: gssapi; sys_platform != "win32" and extra == "kerberos"
+Requires-Dist: pywin32; sys_platform == "win32" and extra == "kerberos"
 Provides-Extra: dev
-Requires-Dist: ruff; extra == "dev"
-Requires-Dist: mypy<1.20,>=1.0; extra == "dev"
+Requires-Dist: ruff<0.16,>=0.15; extra == "dev"
+Requires-Dist: mypy<2.4,>=1.0; extra == "dev"
 Requires-Dist: black<27.0,>=24.3.0; extra == "dev"
-Requires-Dist: isort<6.2,>=5.12; extra == "dev"
+Requires-Dist: isort<8.1,>=5.12; extra == "dev"
 Requires-Dist: pytest>=9.0.3; extra == "dev"
 Requires-Dist: pep249abc; extra == "dev"
 Requires-Dist: pytest-asyncio; extra == "dev"
@@ -236,8 +239,6 @@ Requires-Dist: packaging; extra == "dev"
 Requires-Dist: pre-commit; extra == "dev"
 Requires-Dist: python-dotenv; extra == "dev"
 Requires-Dist: pytest-env; extra == "dev"
-Requires-Dist: gssapi; extra == "dev"
-Requires-Dist: pywin32; sys_platform == "win32" and extra == "dev"
 Dynamic: license-file
 
 # mapepire-python
@@ -261,6 +262,7 @@ Dynamic: license-file
   - [Overview](#overview)
   - [Setup](#setup)
     - [Install with `pip`](#install-with-pip)
+      - [Optional: Kerberos authentication support](#optional-kerberos-authentication-support)
     - [Server Component Setup](#server-component-setup)
 - [Quick Start](#quick-start)
 - [Other Connection options](#other-connection-options)
@@ -332,6 +334,23 @@ Dynamic: license-file
 pip install mapepire-python
 ```
 
+#### Optional: Kerberos authentication support
+
+Kerberos authentication (see [Authenticating with Kerberos](#11-authenticating-with-kerberos)) requires the optional `kerberos` extra, which pulls in `gssapi` on Linux/macOS or `pywin32` on Windows:
+
+```bash
+pip install mapepire-python[kerberos]
+```
+
+On Linux, building `gssapi` also requires Kerberos development headers to be available, e.g.:
+
+```bash
+sudo apt install libkrb5-dev      # Debian/Ubuntu
+sudo dnf install krb5-devel       # Fedora/RHEL
+```
+
+If you don't use Kerberos authentication, you don't need this extra — the base `pip install mapepire-python` has no Kerberos dependencies.
+
 ### Server Component Setup
 To use mapire-python, you will need to have the Mapepire Server Component running on your IBM i server. Follow these instructions to set up the server component: [Mapepire Server Installation](https://mapepire-ibmi.github.io/guides/sysadmin/)
 
@@ -404,6 +423,9 @@ job = SQLJob(creds)
 ### 1.1 Authenticating with Kerberos
 If your IBM i is configured to support Kerberos authentication, you can authenticate using Kerberos instead of passing a plain-text password to the `DaemonServer` Object.
 
+> [!NOTE]
+> Kerberos support requires the `kerberos` extra: `pip install mapepire-python[kerberos]`. See [Optional: Kerberos authentication support](#optional-kerberos-authentication-support).
+
 #### 1.1.1 Windows
 
 If your Windows machine is part of a Kerberos realm and supports SSPI authentication, you can authenticate by creating the `DaemonServer` as shown below:
@@ -486,12 +508,14 @@ First create a `mapepire.ini` file in the root of your project with the followin
 
 ```ini title=mapepire.ini
 [mapepire]
-SERVER="SERVER"
-PORT="PORT"
-USER="USER"
-PASSWORD="PASSWORD"
+host=SERVER
+port=PORT
+user=USER
+password=PASSWORD
 ```
 
+> **Note:** The keys must match the `DaemonServer` fields (`host`, `port`, `user`, `password`), and values must **not** be quoted — write `host=myhost`, not `host="myhost"`.
+
 Then you can create a `SQLJob` object by passing the path to the `.ini` file which will handle the connection details
 
 
@@ -573,7 +597,7 @@ logging.getLogger("mapepire_python").setLevel(logging.DEBUG)
 
 # Usage
 
-Depending on your setup and use case, you can choose the most convenient way to configure the connection details. The following usage examples are compatible with all three connection options detailed above. For simplicity, we assume there is a `mapepire.ini` file in the root of the project with the connection details.
+Depending on your setup and use case, you can choose the most convenient way to configure the connection details. The following usage examples are compatible with all four connection options detailed above. For simplicity, we assume there is a `mapepire.ini` file in the root of the project with the connection details.
 
 
 There are four main ways to run queries using `mapepire-python`:

{mapepire_python-0.3.0 → mapepire_python-0.3.1}/mapepire_python.egg-info/requires.txt

@@ -3,10 +3,10 @@ websockets>=14.0
 pep249abc
 
 [dev]
-ruff
-mypy<1.20,>=1.0
+ruff<0.16,>=0.15
+mypy<2.4,>=1.0
 black<27.0,>=24.3.0
-isort<6.2,>=5.12
+isort<8.1,>=5.12
 pytest>=9.0.3
 pep249abc
 pytest-asyncio
@@ -19,7 +19,11 @@ packaging
 pre-commit
 python-dotenv
 pytest-env
+
+[kerberos]
+
+[kerberos:sys_platform != "win32"]
 gssapi
 
-[dev:sys_platform == "win32"]
+[kerberos:sys_platform == "win32"]
 pywin32

{mapepire_python-0.3.0 → mapepire_python-0.3.1}/pyproject.toml

@@ -22,7 +22,7 @@ requires-python = ">=3.10"
 dependencies = [
   "dataclasses-json>=0.6.4",
   "websockets>=14.0",
-  "pep249abc"
+  "pep249abc",
 ]
 license = {file = "LICENSE"}
 
@@ -33,11 +33,15 @@ Changelog = "https://github.com/Mapepire-IBMi/mapepire-python/blob/main/CHANGELO
 Documentation = "https://mapepire-ibmi.github.io/"
 
 [project.optional-dependencies]
+kerberos = [
+    'gssapi; sys_platform != "win32"',
+    'pywin32; sys_platform == "win32"',
+]
 dev = [
-    "ruff",
-    "mypy>=1.0,<1.20",
+    "ruff>=0.15,<0.16",
+    "mypy>=1.0,<2.4",
     "black>=24.3.0,<27.0",
-    "isort>=5.12,<6.2",
+    "isort>=5.12,<8.1",
     "pytest>=9.0.3",
     "pep249abc",
     "pytest-asyncio",
@@ -50,8 +54,6 @@ dev = [
     "pre-commit",
     "python-dotenv",
     "pytest-env",
-    "gssapi",
-    'pywin32; sys_platform == "win32"'
 ]
 
 [tool.setuptools.packages.find]