novaposhta-python-client 0.1.0__tar.gz → 0.1.2__tar.gz

{novaposhta_python_client-0.1.0 → novaposhta_python_client-0.1.2}/PKG-INFO

@@ -1,18 +1,24 @@
 Metadata-Version: 2.1
 Name: novaposhta-python-client
-Version: 0.1.0
+Version: 0.1.2
 Summary: Python client for Nova Poshta API
 Home-page: https://github.com/semolex/novaposhta-python-client
 License: MIT
+Keywords: api,nova-poshta,novaposhta,nova-poshta-api,novaposhta-api
 Author: Oleksii
 Author-email: semolex@live.com
 Requires-Python: >=3.9,<4.0
+Classifier: Development Status :: 4 - Beta
 Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Requires-Dist: httpx (>=0.25.0,<0.26.0)
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: httpx (>=0.24.0)
 Project-URL: Repository, https://github.com/semolex/novaposhta-python-client
 Description-Content-Type: text/markdown
 
@@ -29,17 +35,15 @@ with emphasis on consistency and usability.
 This client is compatible with `python = "^3.9"` and aims to mirror the Nova Poshta API's endpoints, offering a 1:1
 mapping where possible. However, users should be aware of the inconsistencies and occasional ambiguities present in the
 API. This can affect the signatures of some methods, and special attention is needed when working with endpoints like
-the save method which can create different items based on the provided input.
+the `save` method from some models which can create different items based on the provided input.
 
 Efforts to enhance the consistency and robustness of the client are ongoing, and future releases will focus on thorough
 testing and refinement of all possible parameter combinations.
 
 ## Installation
 
-The package will be available on PyPI soon. For now, it can be installed directly from the GitHub repository
-
 ```bash
-pip install git+https://github.com/semolex/novaposhta-python-client
+pip install novaposhta-python-client==0.1.0
 ```
 
 ## Usage
@@ -61,6 +65,25 @@ return_reason = client.additional_service.get_return_reasons()
 print(settlements, my_pack_list, return_reason)
 ```
 
+## Error handling
+
+```python
+import httpx
+from novaposhta.client import NovaPoshtaApi, InvalidAPIKeyError, APIRequestError
+
+# Instantiate the client
+client = NovaPoshtaApi('my-api-token', timeout=30, raise_for_errors=True)
+
+try:
+    client.common.get_cargo_types()
+except httpx.HTTPError as error:
+    print(f"HTTP error: {error}")
+except InvalidAPIKeyError as error:
+    print(f"API key expired or otherwise invalid: {error}")
+except APIRequestError as error:
+    print(f"Something else is wrong with API request: {error}")
+```
+
 ## Extending the Client
 
 ### Custom HTTP Client
@@ -72,7 +95,7 @@ follows the same interface:
 from novaposhta.client import NovaPoshtaApi
 import my_http_client
 
-client = NovaPoshtaApi('my-api-token', http_client=my_http_client.Client())
+client = NovaPoshtaApi('my-api-token', http_client=my_http_client.Client)
 ```
 
 Custom client should support context manager, e.g:
@@ -126,4 +149,5 @@ poetry run pytest tests/
 
 We welcome contributions that can help in enhancing the functionality and improving the consistency of the client. For
 bugs or feature requests, please open an issue on the GitHub repository.
+Please, use `black` and `mypy` as your instrument for code formatting and type checking.
 

{novaposhta_python_client-0.1.0 → novaposhta_python_client-0.1.2}/README.md

@@ -11,17 +11,15 @@ with emphasis on consistency and usability.
 This client is compatible with `python = "^3.9"` and aims to mirror the Nova Poshta API's endpoints, offering a 1:1
 mapping where possible. However, users should be aware of the inconsistencies and occasional ambiguities present in the
 API. This can affect the signatures of some methods, and special attention is needed when working with endpoints like
-the save method which can create different items based on the provided input.
+the `save` method from some models which can create different items based on the provided input.
 
 Efforts to enhance the consistency and robustness of the client are ongoing, and future releases will focus on thorough
 testing and refinement of all possible parameter combinations.
 
 ## Installation
 
-The package will be available on PyPI soon. For now, it can be installed directly from the GitHub repository
-
 ```bash
-pip install git+https://github.com/semolex/novaposhta-python-client
+pip install novaposhta-python-client==0.1.0
 ```
 
 ## Usage
@@ -43,6 +41,25 @@ return_reason = client.additional_service.get_return_reasons()
 print(settlements, my_pack_list, return_reason)
 ```
 
+## Error handling
+
+```python
+import httpx
+from novaposhta.client import NovaPoshtaApi, InvalidAPIKeyError, APIRequestError
+
+# Instantiate the client
+client = NovaPoshtaApi('my-api-token', timeout=30, raise_for_errors=True)
+
+try:
+    client.common.get_cargo_types()
+except httpx.HTTPError as error:
+    print(f"HTTP error: {error}")
+except InvalidAPIKeyError as error:
+    print(f"API key expired or otherwise invalid: {error}")
+except APIRequestError as error:
+    print(f"Something else is wrong with API request: {error}")
+```
+
 ## Extending the Client
 
 ### Custom HTTP Client
@@ -54,7 +71,7 @@ follows the same interface:
 from novaposhta.client import NovaPoshtaApi
 import my_http_client
 
-client = NovaPoshtaApi('my-api-token', http_client=my_http_client.Client())
+client = NovaPoshtaApi('my-api-token', http_client=my_http_client.Client)
 ```
 
 Custom client should support context manager, e.g:
@@ -108,3 +125,4 @@ poetry run pytest tests/
 
 We welcome contributions that can help in enhancing the functionality and improving the consistency of the client. For
 bugs or feature requests, please open an issue on the GitHub repository.
+Please, use `black` and `mypy` as your instrument for code formatting and type checking.

{novaposhta_python_client-0.1.0 → novaposhta_python_client-0.1.2}/novaposhta/client.py

@@ -35,6 +35,7 @@ class NovaPoshtaApi:
         api_endpoint="https://api.novaposhta.ua/v2.0/json/",
         http_client=httpx,
         timeout=10,
+        raise_for_errors=False,
     ):
         """
         Initialize Nova Poshta API client.
@@ -43,11 +44,13 @@ class NovaPoshtaApi:
         :param api_endpoint: API endpoint to use.
         :param http_client: HTTP client to use. Defaults to httpx.
         :param timeout: Timeout for HTTP requests.
+        :param raise_for_errors: Whether to check and raise errors as exceptions.
         """
         self.api_key = api_key
         self.api_endpoint = api_endpoint
         self.http_client = http_client.Client
         self.timeout = timeout
+        self.raise_for_errors = raise_for_errors
         self._models_pool = {}
 
     def send(
@@ -71,7 +74,7 @@ class NovaPoshtaApi:
             response = client.post(
                 self.api_endpoint, json=request, headers=HEADERS, timeout=self.timeout
             )
-        return response.json()
+        return self._maybe_check_errors(response.json())
 
     def new(self, model: Type[BaseModelType]) -> BaseModelType:
         """
@@ -96,6 +99,19 @@ class NovaPoshtaApi:
         """
         return self._models_pool.get(name)
 
+    def _maybe_check_errors(self, response):
+        if not self.raise_for_errors:
+            return response
+
+        if response["success"]:
+            return response
+
+        error = response["errors"][0]
+        if error.startswith("API key"):
+            raise InvalidAPIKeyError(error)
+        else:
+            raise APIRequestError(error)
+
     @property
     def address(self) -> Address:
         """
@@ -151,3 +167,15 @@ class NovaPoshtaApi:
         Provide access to the TrackingDocument model.
         """
         return self.new(TrackingDocument)
+
+
+class NovaPoshtaError(Exception):
+    """General Nova Poshta exception."""
+
+
+class InvalidAPIKeyError(NovaPoshtaError):
+    """Invalid API key exception."""
+
+
+class APIRequestError(NovaPoshtaError):
+    """Invalid API request exception."""

{novaposhta_python_client-0.1.0 → novaposhta_python_client-0.1.2}/novaposhta/models/base.py

@@ -1,5 +1,6 @@
 """BaseModel module."""
 
+from functools import wraps
 from typing import Any
 
 from ..types import DictStrAny
@@ -12,6 +13,7 @@ def api_method(method_name: str):
     """
 
     def decorator(func):
+        @wraps(func)
         def wrapper(self, *args, **kwargs):
             props = func(self, *args, **kwargs)
             return self._call(method_name, props)

{novaposhta_python_client-0.1.0 → novaposhta_python_client-0.1.2}/pyproject.toml

@@ -3,17 +3,27 @@ name = "novaposhta-python-client"
 packages = [
     { include = "novaposhta"}
 ]
-version = "0.1.0"
+version = "0.1.2"
 description = "Python client for Nova Poshta API"
 authors = ["Oleksii <semolex@live.com>"]
 license = "MIT"
 readme = "README.md"
 homepage = "https://github.com/semolex/novaposhta-python-client"
 repository = "https://github.com/semolex/novaposhta-python-client"
+keywords = [ "api", "nova-poshta", "novaposhta", "nova-poshta-api", "novaposhta-api"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Topic :: Software Development :: Build Tools",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.9",
+    "License :: OSI Approved :: MIT License"
+]
 
 [tool.poetry.dependencies]
 python = "^3.9"
-httpx = "^0.25.0"
+httpx = ">=0.24.0"
 
 
 [tool.poetry.group.dev.dependencies]