spyreapi 0.0.1__tar.gz → 0.0.2__tar.gz

{spyreapi-0.0.1 → spyreapi-0.0.2}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) [2025] [2025]
+Copyright (c) [2025] [Sanjid Sharaf]
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

spyreapi-0.0.2/MANIFEST.in

@@ -0,0 +1,3 @@
+include README.md
+include LICENSE
+global-exclude *.pyc

{spyreapi-0.0.1/src/spyreapi.egg-info → spyreapi-0.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: spyreapi
-Version: 0.0.1
+Version: 0.0.2
 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
@@ -11,6 +11,13 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: requests>=2.32.0
+Requires-Dist: httpx>=0.28.0
+Requires-Dist: pydantic>=2.11.0
+Requires-Dist: python-dotenv>=1.1.0
+Requires-Dist: pandas>=2.3.0
+Requires-Dist: openpyxl>=3.1.5
+Requires-Dist: numpy>=2.3.0
 Dynamic: license-file
 
 # Spire API Python Client

{spyreapi-0.0.1 → spyreapi-0.0.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "spyreapi"
-version = "0.0.1"
+version = "0.0.2"
 authors = [
   { name="Sanjid Sharaf", email="sanjidsharaf1@gmail.com" },
 ]
@@ -18,6 +18,16 @@ classifiers = [
 license = "MIT"
 license-files = ["LICEN[CS]E*"]
 
+dependencies = [
+  "requests>=2.32.0",
+  "httpx>=0.28.0",
+  "pydantic>=2.11.0",
+  "python-dotenv>=1.1.0",
+  "pandas>=2.3.0",
+  "openpyxl>=3.1.5",
+  "numpy>=2.3.0"
+]
+
 [project.urls]
 Homepage = "https://github.com/sanjid-sharaf/spyre/"
 Issues = "https://github.com/sanjid-sharaf/spyre/issues"

{spyreapi-0.0.1 → spyreapi-0.0.2}/src/spyre/Exceptions.py

@@ -1,23 +1,3 @@
-
-"""
->Cannot Convert Invoice to Quote
->Inactive Item
->invalide Syntax for date time
->A database error has occurred:\n\nA value passed to the database was too long for the column - Country Name 
->Order Number Exists
->Invalid Customer
->Missing Parent/Child errror -> id of addresses
-
-Contacts 3
-Request Failure
-Not Found
-invalid Field for filter
-
-
-{'status_code': 422, 'url': 'https://red-wave-8362.spirelan.com:10880/api/v2/companies/intertest/sales/orders/31308/invoice', 
-'content': {'type': 'error', 'message': 'Cannot post a deleted order', 'traceback': '', 'error_type': 'BusinessViolationError'}}
-"""
-
 class CreateRequestError(Exception):
     """
     Exception raised when a create (POST) request to the API fails.
@@ -42,4 +22,25 @@ class CreateRequestError(Exception):
             "status_code": self.status_code,
             "error_message": self.error_message,
             "response_body": self.response_body,
-        }
+        }
+    
+
+"""
+Other Common Exceptions that occur during us of the Spire API includes but not limited to the following
+I have yet to implement these in code and catch them while makin requests. Something to do in the Future 
+
+The following are errors that occur for the sales module 
+>Cannot Invoice a Quote
+>Inactive Item
+>Invalid Syntax for date time
+>A database error has occurred:\n\nA value passed to the database was too long for the column - Country Name 
+>Order Number Exists
+>Invalid Customer
+>Missing Parent/Child errror -> id of addresses
+
+Only 3 Contact record per an address record in the api body
+Request Failure
+Not Found
+invalid Field for filter
+
+"""

{spyreapi-0.0.1 → spyreapi-0.0.2}/src/spyre/Models/customers_models.py

@@ -1,6 +1,6 @@
 from typing import List, Optional, Dict, Union, Any
 from pydantic import BaseModel, model_validator
-from Models.shared_models import *
+from .shared_models import Address
 
 class Customer(BaseModel):
     id: Optional[int] = None

{spyreapi-0.0.1 → spyreapi-0.0.2}/src/spyre/Models/sales_models.py

@@ -1,7 +1,7 @@
 from typing import List, Optional, Dict, Union
 from pydantic import BaseModel, model_validator
-from Models.shared_models import *
-from Models.customers_models import Customer
+from .shared_models import Address, Currency, Contact, Tax
+from .customers_models import Customer
 
 class Inventory(BaseModel):
     id: Optional[int] = None

{spyreapi-0.0.1 → spyreapi-0.0.2}/src/spyre/__init__.py

@@ -1,11 +1,16 @@
 from .client import SpireClient
-from .inventory import InventoryClient
+from .spire import Spire
+from .inventory import InventoryClient, ItemsClient
 from .sales import OrdersClient, InvoiceClient, salesOrder, invoice
+from .customers import CustomerClient, customer
 from .Models.sales_models import SalesOrder, SalesOrderItem
 from .Models.inventory_models import InventoryItem, Vendor, UnitOfMeasure, Pricing, UPC
+from .Exceptions import CreateRequestError
 
 __all__ = [
     "SpireClient",
+    "Spire",
+    "ItemsClient",
     "InventoryClient",
     "SalesOrderClient",
     "SalesOrder",
@@ -18,5 +23,8 @@ __all__ = [
     "OrdersClient",
     "InvoiceClient",
     "salesOrder",
-    "invoice"
+    "invoice",
+    "CustomerClient",
+    "customer",
+    "CreateRequestError"
 ]

{spyreapi-0.0.1 → spyreapi-0.0.2}/src/spyre/client.py

@@ -1,5 +1,5 @@
 import requests
-from config import BASE_URL
+from .config import BASE_URL
 from typing import TypeVar, Optional, Type, Generic, List, Union, Tuple, Dict, Any
 from pydantic import BaseModel
 import json

spyreapi-0.0.2/src/spyre/config.py

@@ -0,0 +1,8 @@
+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.1 → spyreapi-0.0.2}/src/spyre/customers.py

@@ -1,7 +1,6 @@
-from client import SpireClient
-from Models.customers_models import Customer
-from client import APIResource
-from Exceptions import *
+from .client import SpireClient, APIResource
+from .Models.customers_models import Customer
+from .Exceptions import CreateRequestError
 from urllib.parse import urlparse
 from typing import Optional, Dict, Any, List
 

{spyreapi-0.0.1 → spyreapi-0.0.2}/src/spyre/inventory.py

@@ -1,25 +1,10 @@
-from Models.inventory_models import *
-import utils
-from client import *
+from .Models.inventory_models import InventoryItem, UnitOfMeasure, UPC
+from .client import SpireClient, APIResource
 from urllib.parse import urlparse 
-from Exceptions import *
-from typing import Any
+from .Exceptions import CreateRequestError
+from typing import Any, Optional, Dict, List
 from typing import TYPE_CHECKING
 
-""""
-TODO    Get Upc
-        Create UPC
-        Query UPC
-        Delete UPC
-        Update UPC
-
-        Sell Prices
-
-        Counts
-        Adjustements
-
-"""
-
 class InventoryClient():
     
     def __init__(self, client : SpireClient):
@@ -163,7 +148,19 @@ class ItemsClient():
         )
     
     def get_item_uoms(self, id : int) -> List["uom"]:
-        
+        """
+        Retrieve all Unit of Measure (UOM) entries for a specific inventory item.
+
+        This method sends a GET request to the Spire API to retrieve the unit of measure
+        records associated with the specified inventory item ID. Each returned record is 
+        wrapped into a `uom` object, which includes the model and the client reference.
+
+        Args:
+            id (int): The unique identifier of the inventory item.
+
+        Returns:
+            List[uom]: A list of `uom` objects representing the UOM records for the item.
+        """
         uoms = []
         response = self.client._get(f"{self.endpoint}/{str(id)}/uoms")
         items = response.get('records')
@@ -173,13 +170,43 @@ class ItemsClient():
         return uoms
 
     def get_uom(self, item_id :int , uom_id : int) -> "uom":
+        """
+        Retrieve a specific Unit of Measure (UOM) for a given inventory item.
+
+        This method sends a GET request to the Spire API to fetch a single UOM record
+        associated with a specific inventory item and UOM ID. The response is wrapped
+        into a `uom` object that maintains a reference to the API client.
+
+        Args:
+            item_id (int): The unique ID of the inventory item.
+            uom_id (int): The unique ID of the UOM to retrieve.
+
+        Returns:
+            uom: A `uom` object representing the retrieved unit of measure.
 
+        """
         response = self.client._get(f"/{self.endpoint}/{str(item_id)}/uoms/{str(uom_id)}")
         return uom.from_json(response, self.client)
     
 
     def create_item_uom(self, id: int, uom : UnitOfMeasure) -> List["uom"]:
-        
+        """
+        Create a new Unit of Measure (UOM) for a specific inventory item.
+
+        Sends a POST request to the Spire API to create a new UOM for the inventory item
+        with the specified ID. If successful, the method retrieves and returns the newly
+        created UOM object. If the creation fails, an exception is raised.
+
+        Args:
+            id (int): The ID of the inventory item for which to create the UOM.
+            uom (UnitOfMeasure): A Pydantic model instance representing the UOM to create.
+
+        Returns:
+            List[uom]: A list containing the created `uom` object.
+
+        Raises:
+            CreateRequestError: If the API response status is not 201 (Created).
+        """
         response =  self.client._post(f"/{self.endpoint}/{str(id)}/uoms", json=uom.model_dump(exclude_unset=True, exclude_none=True))
         if response.get('status_code') == 201:
             location = response.get('headers').get('location')
@@ -192,17 +219,53 @@ class ItemsClient():
             raise CreateRequestError(self.endpoint, status_code=response.get('status_code'), error_message=error_message)
 
     def delete_uom(self, item_id : int, uom_id :int) -> bool:
+        """
+        Delete a Unit of Measure (UOM) from a specific inventory item.
+
+        Sends a DELETE request to the Spire API to remove a UOM associated with the
+        given item and UOM ID.
 
+        Args:
+            item_id (int): The ID of the inventory item.
+            uom_id (int): The ID of the Unit of Measure to delete.
+
+        Returns:
+            bool: True if the deletion was successful, otherwise raises an error.
+        """
         return self.client._delete(f"/{self.endpoint}/{str(item_id)}/uoms/{str(uom_id)}")
     
     def update_item_uom(self, item_id: int, uom_id : int, uom :'uom') -> 'uom':
+        """
+        Update an existing Unit of Measure (UOM) for a given inventory item.
+
+        Sends a PUT request to the Spire API to update the UOM record with the specified
+        item and UOM ID using the provided `uom` data.
 
+        Args:
+            item_id (int): The ID of the inventory item.
+            uom_id (int): The ID of the UOM to update.
+            uom (uom): A `uom` instance with updated field values.
+
+        Returns:
+            uom: The updated `uom` instance returned from the API.
+        """
         response = self.client._put(f"/{self.endpoint}/{str(item_id)}/{str(uom_id)}", json=uom.model_dump(exclude_none=True, exclude_unset=True))
         return uom.from_json(response, self.client)
     
 
     def get_item_upcs(self, id : int) -> List["upc"]:
-        
+        """
+        Retrieve all UPC records associated with a specific inventory item.
+
+        Sends a GET request to the Spire API to fetch UPCs for the specified item ID,
+        then constructs and returns a list of `upc` objects.
+
+        Args:
+            id (int): The ID of the inventory item.
+
+        Returns:
+            List[upc]: A list of `upc` objects representing the item's UPC codes.
+        """
         upcs = []
         response = self.client._get(f"{self.endpoint}/{str(id)}/upcs")
         items = response.get('records')
@@ -212,11 +275,6 @@ class ItemsClient():
         return upcs
     
 
-        # def get_uom(self, item_id :int , uom_id : int) -> "uom":
-
-        # response = self.client._get(f"/{self.endpoint}/{str(item_id)}/uoms/{str(uom_id)}")
-        # return uom.from_json(response, self.client)
-
 class item(APIResource[InventoryItem]):
     
     endpoint =  'inventory/items'
@@ -257,7 +315,15 @@ class item(APIResource[InventoryItem]):
         return item.from_json(response, self._client)    
     
     def get_uoms(self) -> List["uom"]:
-        
+        """
+        Retrieve all Unit of Measure (UOM) records for the current inventory item.
+
+        This method sends a GET request to the Spire API and returns all UOMs
+        associated with this item's ID.
+
+        Returns:
+            List[uom]: A list of `uom` instances representing the available units of measure.
+        """       
         uoms = []
         response = self._client._get(f"{self.endpoint}/{self.id}/uoms")
         items = response.get('records')
@@ -268,7 +334,22 @@ class item(APIResource[InventoryItem]):
     
 
     def add_uom(self, uom : UnitOfMeasure) -> List["uom"]:
-        
+        """
+        Add a new Unit of Measure (UOM) to the current inventory item.
+
+        Sends a POST request to the Spire API to create a new UOM record using the provided
+        `UnitOfMeasure` model. If the creation is successful (HTTP 201), it retrieves
+        and returns the created UOM.
+
+        Args:
+            uom (UnitOfMeasure): The UnitOfMeasure Pydantic model to be created.
+
+        Returns:
+            List[uom]: A list containing the newly created `uom` instance.
+
+        Raises:
+            CreateRequestError: If the API returns a non-201 status code during creation.
+        """
         response =  self.client._post(f"/{self.endpoint}/{str(self.id)}/uoms", json=uom.model_dump(exclude_unset=True, exclude_none=True))
         if response.get('status_code') == 201:
             location = response.get('headers').get('location')
@@ -328,9 +409,6 @@ class UpcClient():
     def __init__(self, client : SpireClient):
         self.endpoint = 'inventory/upcs'
 
-
-
-
 class upc(APIResource[UPC]):
     _endpoint = ''         
     Model = ''

{spyreapi-0.0.1 → spyreapi-0.0.2}/src/spyre/sales.py

@@ -1,10 +1,10 @@
-from client import APIResource
-from Models.sales_models import *
-import utils
-from client import SpireClient
+from .client import APIResource
+from .Models.sales_models import SalesOrder, SalesOrderItem, Invoice
+from .utils import *
+from .client import SpireClient
 from urllib.parse import urlparse 
-from Exceptions import *
-from typing import Any
+from .Exceptions import CreateRequestError
+from typing import Any, Optional, List, Dict
 
 class OrdersClient():
 
@@ -292,7 +292,7 @@ class invoice(APIResource[Invoice]):
         Returns:
             salesOrder: The created sales order instance returned by the API.
         """
-        order_converted = utils.create_sales_order_from_invoice(self._model)
+        order_converted = create_sales_order_from_invoice(self._model)
         return OrdersClient(self._client).create_sales_order(order_converted)
 
     def update(self , invoice_: "Invoice" = None) -> 'invoice':

{spyreapi-0.0.1 → spyreapi-0.0.2}/src/spyre/spire.py

@@ -1,7 +1,7 @@
-from client import SpireClient
-from sales import *
-from customers import *
-from inventory import InventoryClient
+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):

{spyreapi-0.0.1 → spyreapi-0.0.2}/src/spyre/utils.py

@@ -1,4 +1,4 @@
-from Models.sales_models import *
+from .Models.sales_models import SalesOrder, Invoice
 from typing import TypeVar, Optional, Type, List, Set
 from copy import deepcopy
 from pydantic import BaseModel

{spyreapi-0.0.1 → spyreapi-0.0.2/src/spyreapi.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: spyreapi
-Version: 0.0.1
+Version: 0.0.2
 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
@@ -11,6 +11,13 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: requests>=2.32.0
+Requires-Dist: httpx>=0.28.0
+Requires-Dist: pydantic>=2.11.0
+Requires-Dist: python-dotenv>=1.1.0
+Requires-Dist: pandas>=2.3.0
+Requires-Dist: openpyxl>=3.1.5
+Requires-Dist: numpy>=2.3.0
 Dynamic: license-file
 
 # Spire API Python Client

{spyreapi-0.0.1 → spyreapi-0.0.2}/src/spyreapi.egg-info/SOURCES.txt

@@ -19,5 +19,6 @@ src/spyre/Models/shared_models.py
 src/spyreapi.egg-info/PKG-INFO
 src/spyreapi.egg-info/SOURCES.txt
 src/spyreapi.egg-info/dependency_links.txt
+src/spyreapi.egg-info/requires.txt
 src/spyreapi.egg-info/top_level.txt
 tests/testing.py

spyreapi-0.0.2/src/spyreapi.egg-info/requires.txt

@@ -0,0 +1,7 @@
+requests>=2.32.0
+httpx>=0.28.0
+pydantic>=2.11.0
+python-dotenv>=1.1.0
+pandas>=2.3.0
+openpyxl>=3.1.5
+numpy>=2.3.0

{spyreapi-0.0.1 → spyreapi-0.0.2}/tests/testing.py

@@ -1,8 +1,5 @@
-from spyre.spire import Spire
-from spyre.Models.sales_models import *
-import json
-from spyre.utils  import *
-from spyre.customers import customer
+import spyre
+import spyre.spire
 
 """
 Tested

spyreapi-0.0.1/MANIFEST.in

@@ -1,2 +0,0 @@
-include README.md
-include LICENSE

spyreapi-0.0.1/src/spyre/config.py

@@ -1,6 +0,0 @@
-import os
-from dotenv import load_dotenv
-
-load_dotenv()
-
-BASE_URL = os.getenv("BASE_URL")