woocommerce-api 0.1.0__tar.gz

woocommerce_api-0.1.0/PKG-INFO

@@ -0,0 +1,7 @@
+Metadata-Version: 2.4
+Name: woocommerce-api
+Version: 0.1.0
+Summary: Add your description here
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.32.5

woocommerce_api-0.1.0/pyproject.toml

@@ -0,0 +1,9 @@
+[project]
+name = "woocommerce-api"
+version = "0.1.0"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "requests>=2.32.5",
+]

woocommerce_api-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

woocommerce_api-0.1.0/src/brands/handler.py

@@ -0,0 +1,55 @@
+from typing import Union
+import requests
+
+from src.brands.models.brand_create import BrandCreate
+
+class BrandHandler:
+
+    def __init__(self, woocommerce_base_url: str, woocommerce_auth: tuple[str]):
+        """Class to handle category's operations
+
+        Args:
+            woocommerce_base_url (str): The base URL of your woocommerce instance www.<...>.com. Do not add the /wp-json/...
+            woocommerce_auth (tuple[str]): A tuple with auth key from woocommerce in the type (ck_...,cs_...)
+        """
+        self.woocommerce_url = woocommerce_base_url
+        self.formatted_url = f'{self.woocommerce_url}/wp-json/wc/v3/products/brands'
+        self.auth = woocommerce_auth
+
+    def retrieve_brands(self) -> list[dict]:
+        res = requests.get(
+            url=self.formatted_url,
+            auth=self.auth
+        )
+        return res.json()
+    
+    def retrieve_single_brand(self, brand: Union[str, int]) -> dict:
+        res = requests.get(
+            url=f'{self.formatted_url}/{brand}',
+        )
+        return res.json()
+    
+    def create_brand(self, brand_reate: BrandCreate) -> dict:
+        res = requests.post(
+            url=self.formatted_url,
+            auth=self.auth,
+            data=brand_reate
+        )
+        return res.json()
+    
+    def delete_brand(self, id: int) -> dict:
+        res = requests.delete(
+            url=f'{self.formatted_url}/{id}',
+            auth=self.auth
+        )
+        return res.json()
+    
+    def assign_brand_to_product(self, product_id: int, brands_id: list[int]) -> dict:
+        res = requests.put(
+            url=f'{self.woocommerce_url}//wp-json/wc/v3/products/{product_id}',
+            auth=self.auth,
+            data={
+                "brands":brands_id
+            }
+        )
+        return res.json()

woocommerce_api-0.1.0/src/brands/models/brand_create.py

@@ -0,0 +1,12 @@
+from dataclasses import dataclass, field
+from src.images import ImageProperties
+
+@dataclass
+class BrandCreate:
+    name: str = field(metadata={"doc": "Category name.mandatory"})
+    slug: str = field(metadata={"doc": "An alphanumeric identifier for the resource unique to its type."})
+    parent: int = field(metadata={"doc": "The ID for the parent of the resource."})
+    description: str = field(metadata={"doc": "HTML description of the resource."})
+    display: str = field(metadata={"doc": "Category archive display type. Options: default, products, subcategories and both. Default is default."})
+    image: ImageProperties = field(metadata={"doc": "See ImageProperties doc."})
+    menu_order: int = field(metadata={"doc": "Menu order, used to custom sort the resource."})

woocommerce_api-0.1.0/src/categories/handler.py

@@ -0,0 +1,82 @@
+from typing import Optional
+import requests
+from src.categories.models import CreateCategory
+
+class CategoryHandler:
+
+    def __init__(self, woocommerce_base_url: str, woocommerce_auth: tuple[str]):
+        """Class to handle category's operations
+
+        Args:
+            woocommerce_base_url (str): The base URL of your woocommerce instance www.<...>.com. Do not add the /wp-json/...
+            woocommerce_auth (tuple[str]): A tuple with auth key from woocommerce in the type (ck_...,cs_...)
+        """
+        self.woocommerce_url = woocommerce_base_url
+        self.formatted_url = f'{self.woocommerce_url}/wp-json/wc/v3/products/categories'
+        self.auth = woocommerce_auth
+
+    def retrieve_categories(self, extra_data: bool = False) -> list[dict]:
+        """Retrieves categories data from the API
+
+        Args:
+            extra_data (bool, optional): If False, it will return only name and ID, if set to true it will retrieve all the category properties. Defaults to False.
+
+        Returns:
+            list[dict]: Output from the API
+        """
+        res = requests.get(
+            url=self.formatted_url,
+            auth=self.auth
+        )
+
+        data = res.json()
+
+        if not extra_data:
+            data = [{"ID":d['id'], "Name": d['name'], "Slug":d["slug"]} for d in data]
+
+        return data
+    
+    def create_category(self, category: CreateCategory) -> dict:
+        res = requests.post(
+            url= self.formatted_url,
+            auth=self.auth,
+            data=category
+        )
+
+        return res.json()
+    
+    def retrive_category_by_id(self, id: int) -> dict:
+        res = requests.get(
+            url=f'{self.formatted_url}/{id}'
+        )
+        return res.json()
+    
+    def update_category(self, id: int, **kwargs) -> dict:
+        res = requests.put(
+            url=f'{self.formatted_url}/{id}',
+            json=kwargs
+        )
+
+        return res.json()
+    
+    def delete_category(self, id: int, force: bool) -> dict:
+        res = requests.delete(
+            url=f'{self.formatted_url}/{id}',
+            params={'force':force}
+        )
+        return res.json()
+    
+    def batch_update(self, create: Optional[list[dict]] = None, update: Optional[list[dict]] = None, delete: Optional[list[int]] = None):
+        d = {}
+        if create:
+            d["create"] = create
+        if update:
+            d["update"] = update
+        if delete:
+            d["delete"] = delete
+        res = requests.post(
+            url=f'{self.formatted_url}/batch',
+            data=d
+        )
+        return res.json()
+        

woocommerce_api-0.1.0/src/categories/models/__init__.py

@@ -0,0 +1,3 @@
+from .category_create import CreateCategory
+
+__all__ = ["CreateCategory"]

woocommerce_api-0.1.0/src/categories/models/category_create.py

@@ -0,0 +1,13 @@
+from dataclasses import dataclass, field
+from src.images import ImageProperties
+
+
+@dataclass
+class CreateCategory:
+    name: str = field(metadata={"doc": "Category name.mandatory"})
+    slug: str = field(metadata={"doc": "An alphanumeric identifier for the resource unique to its type."})
+    parent: int = field(metadata={"doc": "The ID for the parent of the resource."})
+    description: str = field(metadata={"doc": "HTML description of the resource."})
+    display: str = field(metadata={"doc": "Category archive display type. Options: default, products, subcategories and both. Default is default."})
+    image: ImageProperties = field(metadata={"doc": "See ImageProperties doc."})
+    menu_order: int = field(metadata={"doc": "Menu order, used to custom sort the resource."})

woocommerce_api-0.1.0/src/images/__init__.py

@@ -0,0 +1,3 @@
+from .models.image import ImageProperties
+
+__all__ = ["ImageProperties"]

woocommerce_api-0.1.0/src/images/models/image.py

@@ -0,0 +1,9 @@
+from dataclasses import dataclass
+
+@dataclass
+class ImageProperties:
+
+    id: int
+    src: str
+    name: str
+    alt: str

woocommerce_api-0.1.0/src/woocommerce_api.egg-info/PKG-INFO

@@ -0,0 +1,7 @@
+Metadata-Version: 2.4
+Name: woocommerce-api
+Version: 0.1.0
+Summary: Add your description here
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.32.5

woocommerce_api-0.1.0/src/woocommerce_api.egg-info/SOURCES.txt

@@ -0,0 +1,19 @@
+README.md
+pyproject.toml
+src/__init__.py
+src/brands/__init__.py
+src/brands/handler.py
+src/brands/models/__init__.py
+src/brands/models/brand_create.py
+src/categories/__init__.py
+src/categories/handler.py
+src/categories/models/__init__.py
+src/categories/models/category_create.py
+src/images/__init__.py
+src/images/models/__init__.py
+src/images/models/image.py
+src/woocommerce_api.egg-info/PKG-INFO
+src/woocommerce_api.egg-info/SOURCES.txt
+src/woocommerce_api.egg-info/dependency_links.txt
+src/woocommerce_api.egg-info/requires.txt
+src/woocommerce_api.egg-info/top_level.txt

woocommerce_api-0.1.0/src/woocommerce_api.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

woocommerce_api-0.1.0/src/woocommerce_api.egg-info/requires.txt

@@ -0,0 +1 @@
+requests>=2.32.5

woocommerce_api-0.1.0/src/woocommerce_api.egg-info/top_level.txt

@@ -0,0 +1,4 @@
+__init__
+brands
+categories
+images