spyreapi 0.0.3__tar.gz → 0.0.4__tar.gz

{spyreapi-0.0.3/src/spyreapi.egg-info → spyreapi-0.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: spyreapi
-Version: 0.0.3
+Version: 0.0.4
 Summary: A robust and extensible Python client for interacting with the [Spire Business Software API](https://developer.spiresystems.com/reference). This client provides an object-oriented interface to get, create, update, delete, query, filter, sort, and manage various Spire modules such as Sales Orders, Invoices, Inventory Items, and more.
 Author-email: Sanjid Sharaf <sanjidsharaf1@gmail.com>
 License-Expression: MIT
@@ -48,14 +48,32 @@ pip install -r requirements.txt
 
 ## ⚙️ Configuration
 
-- Before using the client, set up your environment configuration:
+- How to set up your spire client
 
-### Add your Base URL to your spire server to a `.env` file
+### Find your Spire URL
 
-- In your project root, create a `.env` file to securely store your Spire configuration.
-- Add the following variable:
+The base URL for the Spire API is the same url provided by Spire that you use to access Spire server and uses port 10880 as default:
+Replace {spire-url} with the url provided by Spire.
 
-```env
-BASE_URL = https://{your-spire-domain}/api/v2/companies/
+- https://{spire-url}:10880/api/v2/
+  
+Spire Cloud
+If you are using Spire cloud you do not need to specify a port. The base URL for API for Spire Cloud customers would be:
+
+- https://{spire-cloud-url}/api/v2/
+
+### Set up your client with your credentials
+
+```python
+from spyre import Spire
+# host is your spire url and the port if applicable
+client = Spire(host = 'your-spire-host', company = 'comapany-name' , username = 'username' , password = 'password' )
+
+```
+
+## Example : Updating the status of an inventory item 
+```python
+item = client.inventory.items.get_item(1101)    # Gets item with id 1101
+item.status = 1                                 # Use either item. or item.model. . item.model. will bring up all attributes
+item.update()
 ```
-- Replace {your-spire-domain} with your actual Spire server's hostname or IP address.

spyreapi-0.0.4/README.md

@@ -0,0 +1,57 @@
+# Spire API Python Client
+
+A robust and extensible Python client for interacting with the [Spire Business Software API](https://developer.spiresystems.com/reference). This client provides an object-oriented interface to get, create, update, delete, query, filter, sort, and manage various Spire modules such as Sales Orders, Invoices, Inventory Items, and more.
+
+---
+
+## ✨ Features
+
+- ✅ Object-oriented resource wrappers for each module (e.g., `salesOrder`, `invoice`, `item`)
+- 🔍 Full-text search via `q` parameter
+- 🔁 Pagination with `start` and `limit` support
+- 🧾 JSON-based advanced filtering (supports `$gt`, `$lt`, `$in`, `$or`, etc.)
+- ↕️ Multi-field sorting with ascending/descending control
+- 🔧 Clean abstraction layer for API endpoints
+- 📦 Powered by `pydantic` models for validation
+
+---
+
+## 📦 Installation
+
+```bash
+pip install -r requirements.txt
+```
+
+---
+
+## ⚙️ Configuration
+
+- How to set up your spire client
+
+### Find your Spire URL
+
+The base URL for the Spire API is the same url provided by Spire that you use to access Spire server and uses port 10880 as default:
+Replace {spire-url} with the url provided by Spire.
+
+- https://{spire-url}:10880/api/v2/
+  
+Spire Cloud
+If you are using Spire cloud you do not need to specify a port. The base URL for API for Spire Cloud customers would be:
+
+- https://{spire-cloud-url}/api/v2/
+
+### Set up your client with your credentials
+
+```python
+from spyre import Spire
+# host is your spire url and the port if applicable
+client = Spire(host = 'your-spire-host', company = 'comapany-name' , username = 'username' , password = 'password' )
+
+```
+
+## Example : Updating the status of an inventory item 
+```python
+item = client.inventory.items.get_item(1101)    # Gets item with id 1101
+item.status = 1                                 # Use either item. or item.model. . item.model. will bring up all attributes
+item.update()
+```

{spyreapi-0.0.3 → spyreapi-0.0.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "spyreapi"
-version = "0.0.3"
+version = "0.0.4"
 authors = [
   { name="Sanjid Sharaf", email="sanjidsharaf1@gmail.com" },
 ]

{spyreapi-0.0.3 → spyreapi-0.0.4}/src/spyre/Models/inventory_models.py

@@ -37,7 +37,11 @@ class UnitOfMeasure(BaseModel):
 
 class Pricing(BaseModel):
     id: Optional[int] = None
-    sellPrices: Optional[List[str]] = None
+    sellPrice: Optional[List[str]] = None
+    currMargin: Optional[str] = None
+    currMarginPct: Optional[str] = None
+    avgMargin: Optional[str] = None
+    avgMarginPct: Optional[str] = None
 
 
 class ItemUDF(BaseModel):
@@ -143,7 +147,7 @@ class InventoryItem(BaseModel):
     manufactureCountry: Optional[str] = None
     harmonizedCode: Optional[str] = None
     extendedDescription: Optional[str] = None
-    pricing: Optional[Dict[str, Pricing]] = None
+    pricing: Optional[Union[ Pricing | Dict[str, Pricing]]] = None
     salesTaxFlags: Optional[Dict[str, Union[str, int, float, bool]]] = None
     images: Optional[List[str]] = None
     defaultExpiryDate: Optional[str] = None
@@ -151,7 +155,7 @@ class InventoryItem(BaseModel):
     upload: Optional[bool] = None
     showOptions: Optional[bool] = None
     lastModified: Optional[str] = None
-    levy: Optional[str] = None
+    levy: Optional[Union[str | dict]] = None
     udf: Optional[ItemUDF] = None
     createdBy: Optional[str] = None
     modifiedBy: Optional[str] = None

{spyreapi-0.0.3 → spyreapi-0.0.4}/src/spyre/client.py

@@ -1,22 +1,46 @@
 import requests
-from .config import BASE_URL
 from typing import TypeVar, Optional, Type, Generic, List, Union, Tuple, Dict, Any
 from pydantic import BaseModel
 import json
 import urllib.parse
+from requests.exceptions import HTTPError, ConnectionError, Timeout, RequestException
 
 T = TypeVar('T', bound=BaseModel)
 
-class SpireClient():
-    
-    def __init__(self, company, username, password,):
+class SpireClient():    
+    """A lightweight client to interact with the Spire API using requests sessions for connection reuse and authenticated calls."""
+    def __init__(self, host, company, username, password,):
+        """
+        :param host (str): Spire Server host
+        :param company (str): Spire company
+        :param username (str): Spire user username.
+        :param password (str): Spire user password.
+        
+        """
         self.session = requests.Session()
         self.session.auth = (username, password)
         self.session.headers.update({
             "accept": "application/json",
             "content-type": "application/json"
         })
-        self.base_url = f"{BASE_URL}/{company}"
+        self.base_url = f"https://{host}/api/v2/companies/{company}"
+
+        try: 
+            response = self.session.get(self.base_url)
+            if response.text == 'No such company intertes':
+                raise ValueError(f"No company entries for {company}")
+            if response.text == 'Unauthorized':
+                raise ValueError(f"Invalid Authorization")
+
+        except ConnectionError as conn_err:
+            print(f"Connection error occurred for : {conn_err}")
+
+        except Timeout as timeout_err:
+            print(f"Request timed out: {timeout_err}")
+
+        except RequestException as req_err:
+            print(f"General error occurred: {req_err}")
+
 
     def _get(self, endpoint, params=None):
 
@@ -45,20 +69,50 @@ class SpireClient():
         return response.json()
 
     def _post(self, endpoint, data=None, json=None):
+        """
+        Send a POST request to the Spire API.
+
+        Args:
+            endpoint (str): The relative API endpoint (e.g., 'sales/orders').
+            data (dict, optional): Data to send in the body of the request.
+            json (dict, optional): JSON data to send in the body of the request.
+
+        Returns:
+            dict: A dictionary containing the response status code, URL, content, and headers.
+        """
         url = f"{self.base_url}/{endpoint.lstrip('/')}"
         response = self.session.post(url, data=data, json=json)
         return self._handle_response(response)
 
     def _put(self, endpoint, data=None, json=None):
+        """
+        Send a PUT request to the Spire API.
+
+        Args:
+            endpoint (str): The relative API endpoint (e.g., 'inventory/items/123').
+            data (dict, optional): Data to send in the body of the request.
+            json (dict, optional): JSON data to send in the body of the request.
+
+        Returns:
+            dict: A dictionary containing the response status code, URL, content, and headers.
+        """
         url = f"{self.base_url}/{endpoint.lstrip('/')}"
         response = self.session.put(url, data=data, json=json)
-        response.raise_for_status()
-        return response.json()
+        return self._handle_response(response)
 
     def _delete(self, endpoint):
+        """
+        Send a DELETE request to the Spire API.
+
+        Args:
+            endpoint (str): The relative API endpoint to delete (e.g., 'inventory/items/123').
+
+        Returns:
+            bool: True if the deletion was successful (status code 200, 202, or 204), False otherwise.
+        """
         url = f"{self.base_url}/{endpoint.lstrip('/')}"
         response = self.session.delete(url)
-        return response.status_code == 200 or response.status_code == 204 or response.status_code == 202
+        return response.status_code in (200, 202, 204)
     
     def _handle_response(self, response):
         
@@ -106,12 +160,14 @@ class SpireClient():
         """
         collected = []
         current_start = start
-
+        remaining = limit
         while True:
+
+            current_limit = min(remaining, 1000)
             # Build the query params as a list of tuples to allow repeated keys like 'sort'
             params: List[Tuple[str, Any]] = [
                 ("start", current_start),
-                ("limit", min(limit, 1000))
+                ("limit", current_limit)
             ]
 
             if query:
@@ -142,10 +198,19 @@ class SpireClient():
             for item in items:
                 collected.append(resource_cls.from_json(item, self))
 
-            if not all or (current_start + limit >= count):
+            # Exit if:
+            # - 'all' is False and we reached the requested 'limit'
+            # - no more items are returned
+            if not all:
+                remaining -= len(items)
+                if remaining <= 0 or len(items) == 0:
+                    break
+
+            # Exit if there are no more items available
+            if (current_start + current_limit) >= count or len(items) == 0:
                 break
 
-            current_start += limit
+            current_start += current_limit
 
         return collected
 

{spyreapi-0.0.3 → spyreapi-0.0.4}/src/spyre/inventory.py

@@ -48,7 +48,7 @@ class ItemsClient():
     
     def create_item(self, item : 'InventoryItem') -> 'item':
         """
-        Create a new Inventory Item in SPire.
+        Create a new Inventory Item in Spire.
 
         Sends a POST request to the Inventory/Items endpoint .
 

{spyreapi-0.0.3 → spyreapi-0.0.4}/src/spyre/sales.py

@@ -250,12 +250,9 @@ class salesOrder(APIResource[SalesOrder]):
  
         """
         response = self._client._post(f"/{self.endpoint}/{str(self.id)}/invoice")
-        if response.get('status_code') == 201:
-            location = response.get('headers').get('location')
-            parsed_url = urlparse(location)
-            path_segments = parsed_url.path.rstrip("/").split("/")
-            id = path_segments[-1]
-            return InvoiceClient(client=self._client).get_invoice(id)
+        if response.get('status_code') == 200:
+            data = response.get('content').get('invoice')
+            return salesOrder.from_json(json_data=data, client= self._client)
         else:
             error_message = response.get('content')
             raise CreateRequestError(self.endpoint, status_code=response.get('status_code'), error_message=error_message)

spyreapi-0.0.4/src/spyre/spire.py

@@ -0,0 +1,23 @@
+from .client import SpireClient
+from .sales import OrdersClient, InvoiceClient
+from .customers import CustomerClient
+from .inventory import InventoryClient
+
+class Spire:
+    def __init__(self, host : str, company : str, username : str, password : str):
+        """
+        Creates a spire Session
+
+        :param host (str): Spire Server host. eg: black-disk-5630.spirelan.com:10880
+        :param company (str): Spire company
+        :param username (str): Spire user username.
+        :param password (str): Spire user password.
+        
+        """
+        self.client = SpireClient(host, company, username, password)
+        self.orders = OrdersClient(self.client)
+        self.invoices = InvoiceClient(self.client)
+        self.customers = CustomerClient(self.client)
+        self.inventory = InventoryClient(self.client)
+
+

{spyreapi-0.0.3 → spyreapi-0.0.4/src/spyreapi.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: spyreapi
-Version: 0.0.3
+Version: 0.0.4
 Summary: A robust and extensible Python client for interacting with the [Spire Business Software API](https://developer.spiresystems.com/reference). This client provides an object-oriented interface to get, create, update, delete, query, filter, sort, and manage various Spire modules such as Sales Orders, Invoices, Inventory Items, and more.
 Author-email: Sanjid Sharaf <sanjidsharaf1@gmail.com>
 License-Expression: MIT
@@ -48,14 +48,32 @@ pip install -r requirements.txt
 
 ## ⚙️ Configuration
 
-- Before using the client, set up your environment configuration:
+- How to set up your spire client
 
-### Add your Base URL to your spire server to a `.env` file
+### Find your Spire URL
 
-- In your project root, create a `.env` file to securely store your Spire configuration.
-- Add the following variable:
+The base URL for the Spire API is the same url provided by Spire that you use to access Spire server and uses port 10880 as default:
+Replace {spire-url} with the url provided by Spire.
 
-```env
-BASE_URL = https://{your-spire-domain}/api/v2/companies/
+- https://{spire-url}:10880/api/v2/
+  
+Spire Cloud
+If you are using Spire cloud you do not need to specify a port. The base URL for API for Spire Cloud customers would be:
+
+- https://{spire-cloud-url}/api/v2/
+
+### Set up your client with your credentials
+
+```python
+from spyre import Spire
+# host is your spire url and the port if applicable
+client = Spire(host = 'your-spire-host', company = 'comapany-name' , username = 'username' , password = 'password' )
+
+```
+
+## Example : Updating the status of an inventory item 
+```python
+item = client.inventory.items.get_item(1101)    # Gets item with id 1101
+item.status = 1                                 # Use either item. or item.model. . item.model. will bring up all attributes
+item.update()
 ```
-- Replace {your-spire-domain} with your actual Spire server's hostname or IP address.

{spyreapi-0.0.3 → spyreapi-0.0.4}/src/spyreapi.egg-info/SOURCES.txt

@@ -5,7 +5,6 @@ pyproject.toml
 src/spyre/Exceptions.py
 src/spyre/__init__.py
 src/spyre/client.py
-src/spyre/config.py
 src/spyre/crm.py
 src/spyre/customers.py
 src/spyre/inventory.py

spyreapi-0.0.3/README.md

@@ -1,39 +0,0 @@
-# Spire API Python Client
-
-A robust and extensible Python client for interacting with the [Spire Business Software API](https://developer.spiresystems.com/reference). This client provides an object-oriented interface to get, create, update, delete, query, filter, sort, and manage various Spire modules such as Sales Orders, Invoices, Inventory Items, and more.
-
----
-
-## ✨ Features
-
-- ✅ Object-oriented resource wrappers for each module (e.g., `salesOrder`, `invoice`, `item`)
-- 🔍 Full-text search via `q` parameter
-- 🔁 Pagination with `start` and `limit` support
-- 🧾 JSON-based advanced filtering (supports `$gt`, `$lt`, `$in`, `$or`, etc.)
-- ↕️ Multi-field sorting with ascending/descending control
-- 🔧 Clean abstraction layer for API endpoints
-- 📦 Powered by `pydantic` models for validation
-
----
-
-## 📦 Installation
-
-```bash
-pip install -r requirements.txt
-```
-
----
-
-## ⚙️ Configuration
-
-- Before using the client, set up your environment configuration:
-
-### Add your Base URL to your spire server to a `.env` file
-
-- In your project root, create a `.env` file to securely store your Spire configuration.
-- Add the following variable:
-
-```env
-BASE_URL = https://{your-spire-domain}/api/v2/companies/
-```
-- Replace {your-spire-domain} with your actual Spire server's hostname or IP address.

spyreapi-0.0.3/src/spyre/config.py

@@ -1,8 +0,0 @@
-import os
-from dotenv import load_dotenv
-
-load_dotenv()
-
-BASE_URL = os.getenv("BASE_URL")
-if not BASE_URL:
-    raise ValueError("BASE_URL environment variable is not set. Please set it before running the application.")

spyreapi-0.0.3/src/spyre/spire.py

@@ -1,14 +0,0 @@
-from .client import SpireClient
-from .sales import OrdersClient, InvoiceClient
-from .customers import CustomerClient
-from .inventory import InventoryClient
-
-class Spire:
-    def __init__(self, company : str, username : str, password : str):
-        self.client = SpireClient(company, username, password)
-        self.orders = OrdersClient(self.client)
-        self.invoices = InvoiceClient(self.client)
-        self.customers = CustomerClient(self.client)
-        self.inventory = InventoryClient(self.client)
-
-