neris-api-client 1.2.1.post0__tar.gz → 1.3.1__tar.gz

{neris_api_client-1.2.1.post0/src/neris_api_client.egg-info → neris_api_client-1.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: neris_api_client
-Version: 1.2.1.post0
+Version: 1.3.1
 Summary: NERIS API Client
 Author-email: Ben Coleman <ben.coleman@ul.org>, Tommy Messbauer <thomas.messbauer@ul.org>, Joseph Pagani <joseph.pagani@ul.org>
 Project-URL: Homepage, https://github.com/ulfsri/neris-api-client
@@ -19,6 +19,12 @@ Requires-Dist: python-dotenv
 
 A Python class to interact with the NERIS API programmatically.
 
+> **NOTE:** Due to the changes and transition to using Oauth 2.0 version 1.2 is now deprecated. Please upgrade to version 1.3. You can do that in a package manager with the following update: `neris-api-client = ">=1.3"` or in your `requirements.txt` you can do `neris-api-client >=1.3`. Or you can install with `pip install neris_api_client>=1.3.`.
+
+## Versioning
+
+This API client does not directly follow semver practices. In order to remove confusion between the NERIS API client and API, we have decided to align the major version of this client with the major version of the API release. The minor and patch versions of this client will differ from API release version, they will instead represent changes made to the API client itself.
+
 ## Installation
 
 To install:
@@ -91,6 +97,14 @@ client = NerisApiClient()
 entity = client.get_entity("FD24027240")
 ```
 
+## Additional config parameters
+
+| Parameter | Description                                                 |
+| --------- | ----------------------------------------------------------- |
+| debug     | Controls whether the application outputs debug information. |
+| validate  | Controls whether the client performs model validations.     |
+
+
 ## Disclaimer
 The models in this package are generated using [`datamodel-code-generator`](https://github.com/koxudaxi/datamodel-code-generator) and are not guaranteed
 to contain all of the information present in the full specification. The generated models are used to validate request payloads prior to

{neris_api_client-1.2.1.post0 → neris_api_client-1.3.1}/README.md

@@ -2,6 +2,12 @@
 
 A Python class to interact with the NERIS API programmatically.
 
+> **NOTE:** Due to the changes and transition to using Oauth 2.0 version 1.2 is now deprecated. Please upgrade to version 1.3. You can do that in a package manager with the following update: `neris-api-client = ">=1.3"` or in your `requirements.txt` you can do `neris-api-client >=1.3`. Or you can install with `pip install neris_api_client>=1.3.`.
+
+## Versioning
+
+This API client does not directly follow semver practices. In order to remove confusion between the NERIS API client and API, we have decided to align the major version of this client with the major version of the API release. The minor and patch versions of this client will differ from API release version, they will instead represent changes made to the API client itself.
+
 ## Installation
 
 To install:
@@ -74,6 +80,14 @@ client = NerisApiClient()
 entity = client.get_entity("FD24027240")
 ```
 
+## Additional config parameters
+
+| Parameter | Description                                                 |
+| --------- | ----------------------------------------------------------- |
+| debug     | Controls whether the application outputs debug information. |
+| validate  | Controls whether the client performs model validations.     |
+
+
 ## Disclaimer
 The models in this package are generated using [`datamodel-code-generator`](https://github.com/koxudaxi/datamodel-code-generator) and are not guaranteed
 to contain all of the information present in the full specification. The generated models are used to validate request payloads prior to

{neris_api_client-1.2.1.post0 → neris_api_client-1.3.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "neris_api_client"
-version = "1.2.1.post0"
+version = "1.3.1"
 authors = [
   { name="Ben Coleman", email="ben.coleman@ul.org" },
   { name="Tommy Messbauer", email="thomas.messbauer@ul.org" },

{neris_api_client-1.2.1.post0 → neris_api_client-1.3.1}/src/neris_api_client/client.py

@@ -161,7 +161,7 @@ class _NerisApiClient:
         self._update_auth()
         self._session.headers.update({"Authorization": f"Bearer {self.tokens.access_token}"})
 
-        if model:
+        if self.config.validate and model:
             if isinstance(data, str):
                 data = model.model_validate_json(data).model_dump(mode="json", by_alias=True)
             if isinstance(data, dict):

{neris_api_client-1.2.1.post0 → neris_api_client-1.3.1}/src/neris_api_client/config.py

@@ -16,11 +16,13 @@ class Config:
     client_id: str | None = None
     client_secret: str | None = None
     grant_type: GrantType | None = None
+    validate: bool | None = None
 
     def __post_init__(self):
         # env var handling
         self.base_url = self.base_url or os.getenv("NERIS_BASE_URL")
         self.debug = self.debug if self.debug is not None else os.getenv("NERIS_DEBUG") == "true"
+        self.validate = self.validate if self.validate is not None else os.getenv("NERIS_VALIDATE") == "true"
 
         match os.getenv("NERIS_GRANT_TYPE"):
             case GrantType.PASSWORD:

{neris_api_client-1.2.1.post0 → neris_api_client-1.3.1/src/neris_api_client.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: neris_api_client
-Version: 1.2.1.post0
+Version: 1.3.1
 Summary: NERIS API Client
 Author-email: Ben Coleman <ben.coleman@ul.org>, Tommy Messbauer <thomas.messbauer@ul.org>, Joseph Pagani <joseph.pagani@ul.org>
 Project-URL: Homepage, https://github.com/ulfsri/neris-api-client
@@ -19,6 +19,12 @@ Requires-Dist: python-dotenv
 
 A Python class to interact with the NERIS API programmatically.
 
+> **NOTE:** Due to the changes and transition to using Oauth 2.0 version 1.2 is now deprecated. Please upgrade to version 1.3. You can do that in a package manager with the following update: `neris-api-client = ">=1.3"` or in your `requirements.txt` you can do `neris-api-client >=1.3`. Or you can install with `pip install neris_api_client>=1.3.`.
+
+## Versioning
+
+This API client does not directly follow semver practices. In order to remove confusion between the NERIS API client and API, we have decided to align the major version of this client with the major version of the API release. The minor and patch versions of this client will differ from API release version, they will instead represent changes made to the API client itself.
+
 ## Installation
 
 To install:
@@ -91,6 +97,14 @@ client = NerisApiClient()
 entity = client.get_entity("FD24027240")
 ```
 
+## Additional config parameters
+
+| Parameter | Description                                                 |
+| --------- | ----------------------------------------------------------- |
+| debug     | Controls whether the application outputs debug information. |
+| validate  | Controls whether the client performs model validations.     |
+
+
 ## Disclaimer
 The models in this package are generated using [`datamodel-code-generator`](https://github.com/koxudaxi/datamodel-code-generator) and are not guaranteed
 to contain all of the information present in the full specification. The generated models are used to validate request payloads prior to