shopyo-ecommerce 0.1.0__tar.gz

shopyo_ecommerce-0.1.0/PKG-INFO

@@ -0,0 +1,152 @@
+Metadata-Version: 2.4
+Name: shopyo_ecommerce
+Version: 0.1.0
+Summary: Full-featured ecommerce module for Shopyo Flask apps — products, cart, checkout, orders, POS, inventory, and API
+Author-email: ShopCube <dev@shopcube.app>
+License-Expression: BSD-3-Clause
+Project-URL: Homepage, https://github.com/shopcube/shopcube
+Project-URL: Bug Tracker, https://github.com/shopcube/shopcube/issues
+Keywords: shopyo,ecommerce,flask,flask-ecommerce,shopping-cart,online-store,point-of-sale,pos,inventory,order-management,python-ecommerce,flask-shop
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: shopyo
+Requires-Dist: shopyo-appadmin
+Requires-Dist: shopyo-auth
+Requires-Dist: shopyo-dashboard
+
+# 🛒 Shopyo Ecommerce — Plug & Play Python Ecommerce for Shopyo
+
+**shopyo-ecommerce** is a full-featured, plug-and-play ecommerce module for the [Shopyo](https://shopyo.readthedocs.io/) Flask framework. Add products, categories, variants, cart, checkout, and order management to your Shopyo app in minutes — no boilerplate, no fuss.
+
+---
+
+## ✨ Features
+
+- **Product & Category Management** — CRUD for products and categories with image uploads
+- **Inventory Tracking** — stock counts, low-stock alerts, and variant support
+- **Shopping Cart** — session-based cart with quantity controls
+- **Checkout Flow** — address collection, order summary, and payment integration hooks
+- **Order Dashboard** — admin order management with status tracking
+- **POS Interface** — point-of-sale view for in-person transactions
+- **RESTful API** — JSON endpoints for headless or mobile frontends
+- **Shopyo Native** — respects Shopyo's theming, auth, dashboard, and settings
+
+---
+
+## 🚀 Quick Start
+
+```bash
+pip install shopyo-ecommerce
+```
+
+Then initialise it in your Shopyo app factory:
+
+```python
+from shopyo_ecommerce import ShopyoEcommerce
+
+def create_app():
+    app = Flask(__name__)
+    # ... load extensions ...
+    ShopyoEcommerce(app)
+    return app
+```
+
+That's it. The ecommerce sub-modules (shop, pos, orders, etc.) will appear automatically in the dashboard and be ready at their default routes.
+
+## 🎨 Theme Commands
+
+Copy the ecommerceus front theme into your project so you can customise it:
+
+```bash
+flask shopyo-ecommerce copy front ecommerceus
+```
+
+To overwrite an already-copied theme (backup first if needed):
+
+```bash
+flask shopyo-ecommerce update front ecommerceus
+```
+
+The theme lands at `static/themes/front/ecommerceus/` and becomes available in the Shopyo theme picker.
+
+---
+
+## 📦 What's Inside
+
+| Sub-module | Route Prefix | Description |
+|---|---|---|
+| `shop` | `/shop` | Product listing, detail, cart, checkout |
+| `pos` | `/pos` | Point-of-sale interface |
+| `category` | `/category` | Category management |
+| `product` | `/product` | Product management |
+| `order` | `/order` | Order management |
+| `delivery` | `/delivery` | Delivery configuration |
+| `payment` | `/payment` | Payment gateway hooks |
+| `resource` | `/resource` | Image & asset serving |
+
+---
+
+## 🔧 Configuration
+
+All settings are configured via Flask app config keys. Set them in your `config.py` or before calling `ShopyoEcommerce(app)`.
+
+| Config Key | Default | Description |
+|---|---|---|
+| `SHOPYO_ECOMMERCE_URL` | `/shopyo-ecommerce` | URL prefix for all ecommerce routes |
+| `SHOPYO_ECOMMERCE_CURRENCY` | `USD` | Default currency code (e.g. `USD`, `EUR`, `MUR`) |
+| `SHOPYO_ECOMMERCE_SECTION_NAME` | `Shop` | Name shown in dashboard & settings for the ecommerce section |
+| `SHOPYO_ECOMMERCE_ITEMS_PER_PAGE` | `12` | Number of products per page in shop listings |
+| `SHOPYO_ECOMMERCE_ENABLE_WISHLIST` | `True` | Enable/disable the wishlist feature |
+| `SHOPYO_ECOMMERCE_ENABLE_REVIEWS` | `False` | Enable/disable product reviews |
+| `SHOPYO_ECOMMERCE_CATEGORYPHOTOS_UPLOADSET` | `categoryphotos` | Flask-Uploads set name for category images |
+| `SHOPYO_ECOMMERCE_SUBCATEGORYPHOTOS_UPLOADSET` | `subcategoryphotos` | Flask-Uploads set name for subcategory images |
+| `SHOPYO_ECOMMERCE_PRODUCTEXCEL_UPLOADSET` | `productexcel` | Flask-Uploads set name for product Excel imports |
+| `SHOPYO_ECOMMERCE_PRODUCTPHOTOS_UPLOADSET` | `productphotos` | Flask-Uploads set name for product images |
+| `SHOPYO_ECOMMERCE_UPLOADED_CATEGORYPHOTOS_DEST` | `static/uploads/categoryphotos` | Upload destination for category images (relative paths resolved against `BASE_DIR`) |
+| `SHOPYO_ECOMMERCE_UPLOADED_SUBCATEGORYPHOTOS_DEST` | `static/uploads/subcategoryphotos` | Upload destination for subcategory images |
+| `SHOPYO_ECOMMERCE_UPLOADED_PRODUCTEXCEL_DEST` | `static/uploads/productexcel` | Upload destination for product Excel files |
+| `SHOPYO_ECOMMERCE_UPLOADED_PRODUCTPHOTOS_DEST` | `static/uploads/productphotos` | Upload destination for product images |
+
+**Example:**
+
+```python
+class Config:
+    SHOPYO_ECOMMERCE_URL = "/shop"
+    SHOPYO_ECOMMERCE_CURRENCY = "EUR"
+    SHOPYO_ECOMMERCE_ITEMS_PER_PAGE = 24
+    SHOPYO_ECOMMERCE_UPLOADED_PRODUCTPHOTOS_DEST = "/data/uploads/products"
+```
+
+---
+
+## 🧪 Tested With
+
+- Python 3.10+
+- Shopyo 4.18+
+- Flask 2+
+
+---
+
+## 🤝 Contributing
+
+Found a bug? Want a feature? Open an issue at [github.com/shopcube/shopcube](https://github.com/shopcube/shopcube).
+
+---
+
+## 📄 License
+
+BSD-3-Clause. See `LICENSE`.

shopyo_ecommerce-0.1.0/README.md

@@ -0,0 +1,122 @@
+# 🛒 Shopyo Ecommerce — Plug & Play Python Ecommerce for Shopyo
+
+**shopyo-ecommerce** is a full-featured, plug-and-play ecommerce module for the [Shopyo](https://shopyo.readthedocs.io/) Flask framework. Add products, categories, variants, cart, checkout, and order management to your Shopyo app in minutes — no boilerplate, no fuss.
+
+---
+
+## ✨ Features
+
+- **Product & Category Management** — CRUD for products and categories with image uploads
+- **Inventory Tracking** — stock counts, low-stock alerts, and variant support
+- **Shopping Cart** — session-based cart with quantity controls
+- **Checkout Flow** — address collection, order summary, and payment integration hooks
+- **Order Dashboard** — admin order management with status tracking
+- **POS Interface** — point-of-sale view for in-person transactions
+- **RESTful API** — JSON endpoints for headless or mobile frontends
+- **Shopyo Native** — respects Shopyo's theming, auth, dashboard, and settings
+
+---
+
+## 🚀 Quick Start
+
+```bash
+pip install shopyo-ecommerce
+```
+
+Then initialise it in your Shopyo app factory:
+
+```python
+from shopyo_ecommerce import ShopyoEcommerce
+
+def create_app():
+    app = Flask(__name__)
+    # ... load extensions ...
+    ShopyoEcommerce(app)
+    return app
+```
+
+That's it. The ecommerce sub-modules (shop, pos, orders, etc.) will appear automatically in the dashboard and be ready at their default routes.
+
+## 🎨 Theme Commands
+
+Copy the ecommerceus front theme into your project so you can customise it:
+
+```bash
+flask shopyo-ecommerce copy front ecommerceus
+```
+
+To overwrite an already-copied theme (backup first if needed):
+
+```bash
+flask shopyo-ecommerce update front ecommerceus
+```
+
+The theme lands at `static/themes/front/ecommerceus/` and becomes available in the Shopyo theme picker.
+
+---
+
+## 📦 What's Inside
+
+| Sub-module | Route Prefix | Description |
+|---|---|---|
+| `shop` | `/shop` | Product listing, detail, cart, checkout |
+| `pos` | `/pos` | Point-of-sale interface |
+| `category` | `/category` | Category management |
+| `product` | `/product` | Product management |
+| `order` | `/order` | Order management |
+| `delivery` | `/delivery` | Delivery configuration |
+| `payment` | `/payment` | Payment gateway hooks |
+| `resource` | `/resource` | Image & asset serving |
+
+---
+
+## 🔧 Configuration
+
+All settings are configured via Flask app config keys. Set them in your `config.py` or before calling `ShopyoEcommerce(app)`.
+
+| Config Key | Default | Description |
+|---|---|---|
+| `SHOPYO_ECOMMERCE_URL` | `/shopyo-ecommerce` | URL prefix for all ecommerce routes |
+| `SHOPYO_ECOMMERCE_CURRENCY` | `USD` | Default currency code (e.g. `USD`, `EUR`, `MUR`) |
+| `SHOPYO_ECOMMERCE_SECTION_NAME` | `Shop` | Name shown in dashboard & settings for the ecommerce section |
+| `SHOPYO_ECOMMERCE_ITEMS_PER_PAGE` | `12` | Number of products per page in shop listings |
+| `SHOPYO_ECOMMERCE_ENABLE_WISHLIST` | `True` | Enable/disable the wishlist feature |
+| `SHOPYO_ECOMMERCE_ENABLE_REVIEWS` | `False` | Enable/disable product reviews |
+| `SHOPYO_ECOMMERCE_CATEGORYPHOTOS_UPLOADSET` | `categoryphotos` | Flask-Uploads set name for category images |
+| `SHOPYO_ECOMMERCE_SUBCATEGORYPHOTOS_UPLOADSET` | `subcategoryphotos` | Flask-Uploads set name for subcategory images |
+| `SHOPYO_ECOMMERCE_PRODUCTEXCEL_UPLOADSET` | `productexcel` | Flask-Uploads set name for product Excel imports |
+| `SHOPYO_ECOMMERCE_PRODUCTPHOTOS_UPLOADSET` | `productphotos` | Flask-Uploads set name for product images |
+| `SHOPYO_ECOMMERCE_UPLOADED_CATEGORYPHOTOS_DEST` | `static/uploads/categoryphotos` | Upload destination for category images (relative paths resolved against `BASE_DIR`) |
+| `SHOPYO_ECOMMERCE_UPLOADED_SUBCATEGORYPHOTOS_DEST` | `static/uploads/subcategoryphotos` | Upload destination for subcategory images |
+| `SHOPYO_ECOMMERCE_UPLOADED_PRODUCTEXCEL_DEST` | `static/uploads/productexcel` | Upload destination for product Excel files |
+| `SHOPYO_ECOMMERCE_UPLOADED_PRODUCTPHOTOS_DEST` | `static/uploads/productphotos` | Upload destination for product images |
+
+**Example:**
+
+```python
+class Config:
+    SHOPYO_ECOMMERCE_URL = "/shop"
+    SHOPYO_ECOMMERCE_CURRENCY = "EUR"
+    SHOPYO_ECOMMERCE_ITEMS_PER_PAGE = 24
+    SHOPYO_ECOMMERCE_UPLOADED_PRODUCTPHOTOS_DEST = "/data/uploads/products"
+```
+
+---
+
+## 🧪 Tested With
+
+- Python 3.10+
+- Shopyo 4.18+
+- Flask 2+
+
+---
+
+## 🤝 Contributing
+
+Found a bug? Want a feature? Open an issue at [github.com/shopcube/shopcube](https://github.com/shopcube/shopcube).
+
+---
+
+## 📄 License
+
+BSD-3-Clause. See `LICENSE`.

shopyo_ecommerce-0.1.0/pyproject.toml

@@ -0,0 +1,62 @@
+[project]
+name = "shopyo_ecommerce"
+authors = [{ name = "ShopCube", email = "dev@shopcube.app" }]
+description = "Full-featured ecommerce module for Shopyo Flask apps — products, cart, checkout, orders, POS, inventory, and API"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "BSD-3-Clause"
+keywords = [
+    "shopyo",
+    "ecommerce",
+    "flask",
+    "flask-ecommerce",
+    "shopping-cart",
+    "online-store",
+    "point-of-sale",
+    "pos",
+    "inventory",
+    "order-management",
+    "python-ecommerce",
+    "flask-shop",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Information Technology",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
+    "Topic :: Office/Business :: Financial",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+]
+dependencies = [
+    "shopyo",
+    "shopyo-appadmin",
+    "shopyo-auth",
+    "shopyo-dashboard",
+]
+version = "0.1.0"
+
+[project.urls]
+"Homepage" = "https://github.com/shopcube/shopcube"
+"Bug Tracker" = "https://github.com/shopcube/shopcube/issues"
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["shopyo_ecommerce*"]
+
+[tool.setuptools.package-data]
+shopyo_ecommerce = ["static/**", "templates/**", "*/templates/**", "data/**", "**/*.json"]

shopyo_ecommerce-0.1.0/setup.cfg

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

shopyo_ecommerce-0.1.0/shopyo_ecommerce/__init__.py

@@ -0,0 +1,143 @@
+import json
+import os
+from typing import Any
+
+import jinja2
+from flask import Blueprint
+from flask import Flask
+from flask import current_app
+from flask_uploads import DOCUMENTS
+from flask_uploads import IMAGES
+from flask_uploads import configure_uploads
+from flask_uploads import UploadSet
+
+
+__version__ = "0.1.0"
+
+info = {}
+with open(os.path.dirname(os.path.abspath(__file__)) + os.sep + "box_info.json") as f:
+    info = json.load(f)
+
+default_config = {
+    "SHOPYO_ECOMMERCE_URL": "/shopyo-ecommerce",
+    "SHOPYO_ECOMMERCE_CURRENCY": "USD",
+    "SHOPYO_ECOMMERCE_SECTION_NAME": "Shop",
+    "SHOPYO_ECOMMERCE_ITEMS_PER_PAGE": 12,
+    "SHOPYO_ECOMMERCE_ENABLE_WISHLIST": True,
+    "SHOPYO_ECOMMERCE_ENABLE_REVIEWS": False,
+    "SHOPYO_ECOMMERCE_CATEGORYPHOTOS_UPLOADSET": "categoryphotos",
+    "SHOPYO_ECOMMERCE_SUBCATEGORYPHOTOS_UPLOADSET": "subcategoryphotos",
+    "SHOPYO_ECOMMERCE_PRODUCTEXCEL_UPLOADSET": "productexcel",
+    "SHOPYO_ECOMMERCE_PRODUCTPHOTOS_UPLOADSET": "productphotos",
+    "SHOPYO_ECOMMERCE_UPLOADED_CATEGORYPHOTOS_DEST": "static/uploads/categoryphotos",
+    "SHOPYO_ECOMMERCE_UPLOADED_SUBCATEGORYPHOTOS_DEST": "static/uploads/subcategoryphotos",
+    "SHOPYO_ECOMMERCE_UPLOADED_PRODUCTEXCEL_DEST": "static/uploads/productexcel",
+    "SHOPYO_ECOMMERCE_UPLOADED_PRODUCTPHOTOS_DEST": "static/uploads/productphotos",
+}
+
+categoryphotos = UploadSet("categoryphotos", IMAGES)
+subcategoryphotos = UploadSet("subcategoryphotos", IMAGES)
+productexcel = UploadSet("productexcel", DOCUMENTS)
+productphotos = UploadSet("productphotos", IMAGES)
+
+_pkg_dir = os.path.dirname(os.path.abspath(__file__))
+
+blueprint_names = [
+    "category",
+    "customer",
+    "demo",
+    "inventory",
+    "pos",
+    "product",
+    "purchase",
+    "resource",
+    "shop",
+    "shopman",
+    "vendor",
+]
+
+
+class ShopyoEcommerce:
+    def __init__(self, app: Any = None) -> None:
+        if app is not None:
+            self.init_app(app)
+
+    def init_app(self, app: Flask) -> None:
+        if not hasattr(app, "extensions"):
+            app.extensions = {}
+
+        for key, value in default_config.items():
+            app.config.setdefault(key, value)
+
+        url_prefix = app.config.get("SHOPYO_ECOMMERCE_URL", "/shopyo-ecommerce")
+        parent = Blueprint(
+            "shopyo_ecommerce",
+            __name__,
+            url_prefix=url_prefix,
+            template_folder="templates",
+            static_folder="static",
+        )
+
+        for name in blueprint_names:
+            mod = __import__(
+                f"shopyo_ecommerce.{name}.view", fromlist=["module_blueprint"]
+            )
+            parent.register_blueprint(mod.module_blueprint)
+
+        global_modules = [
+            "shopyo_ecommerce.category.global",
+            "shopyo_ecommerce.shop.global",
+            "shopyo_ecommerce.product.global",
+        ]
+
+        for g_path in global_modules:
+            try:
+                mod = __import__(g_path, fromlist=["available_everywhere"])
+                app.jinja_env.globals.update(mod.available_everywhere)
+            except (ImportError, AttributeError):
+                pass
+
+        app.register_blueprint(parent)
+
+        pkg_templates = os.path.join(_pkg_dir, "templates")
+        if os.path.isdir(pkg_templates):
+            current = app.jinja_loader
+            if not isinstance(current, jinja2.ChoiceLoader):
+                current = jinja2.ChoiceLoader([current])
+                app.jinja_loader = current
+            current.loaders.insert(0, jinja2.FileSystemLoader(pkg_templates))
+
+        app.extensions["shopyo_ecommerce"] = self
+
+        from shopyo_ecommerce import cli as shopyo_ecommerce_cli
+
+        app.cli.add_command(shopyo_ecommerce_cli.cli)
+
+        upload_set_names = {
+            "categoryphotos": categoryphotos,
+            "subcategoryphotos": subcategoryphotos,
+            "productexcel": productexcel,
+            "productphotos": productphotos,
+        }
+        base = app.config.get("BASE_DIR", os.getcwd())
+        for name, uset in upload_set_names.items():
+            config_key = f"SHOPYO_ECOMMERCE_UPLOADED_{name.upper()}_DEST"
+            dest = app.config[config_key]
+            if not os.path.isabs(dest):
+                dest = os.path.join(base, dest)
+            app.config[f"UPLOADED_{name.upper()}_DEST"] = dest
+            configure_uploads(app, uset)
+
+    def get_info(self):
+        info_copy = dict(info)
+        modules_info = {}
+        base_url = current_app.config.get("SHOPYO_ECOMMERCE_URL", "/shopyo-ecommerce")
+        for name in blueprint_names:
+            info_path = os.path.join(_pkg_dir, name, "info.json")
+            if os.path.exists(info_path):
+                with open(info_path) as f:
+                    mod_info = json.load(f)
+                mod_info["url_prefix"] = base_url + mod_info.get("url_prefix", f"/{name}")
+                modules_info[name] = mod_info
+        info_copy["modules"] = modules_info
+        return info_copy

shopyo_ecommerce-0.1.0/shopyo_ecommerce/_utils.py

@@ -0,0 +1,40 @@
+import re
+
+from shopyo.api.validators import is_empty_str
+from shopyo.api.file import unique_filename
+from werkzeug.utils import secure_filename
+from wtforms.validators import ValidationError
+
+
+def is_safe_path_component(component):
+    if not component:
+        return False
+    return bool(re.match(r"^[a-zA-Z0-9_.\-]+$", component))
+
+
+def unique_sec_filename(filename):
+    return unique_filename(secure_filename(filename))
+
+
+def require_if_default_address(form, field):
+    if form.diffAddress.data == False:
+        if is_empty_str(field.data):
+            raise ValidationError("{} cannot be empty!".format(field.label))
+
+
+def require_if_diff_address(form, field):
+    if form.diffAddress.data == True:
+        if is_empty_str(field.data):
+            raise ValidationError("{} cannot be empty!".format(field.label))
+
+
+def require_if_apply_coupon(form, field):
+    if form.applyCoupon.data == True:
+        if is_empty_str(field.data):
+            raise ValidationError("{} cannot be empty!".format(field.label))
+
+
+def require_if_create_account(form, field):
+    if form.createAccount.data == True:
+        if is_empty_str(field.data):
+            raise ValidationError("{} cannot be empty!".format(field.label))

shopyo_ecommerce-0.1.0/shopyo_ecommerce/box_info.json

@@ -0,0 +1,9 @@
+{
+        "display_string": "Ecommerce",
+        "box_name":"ecommerce",
+        "author": {
+            "name":"",
+            "website":"",
+            "mail":""
+        }
+    }

shopyo_ecommerce-0.1.0/shopyo_ecommerce/category/forms.py

@@ -0,0 +1,22 @@
+from flask_wtf import FlaskForm
+from flask_wtf.file import FileAllowed
+from flask_wtf.file import FileField
+from flask_wtf.file import FileRequired
+from wtforms import SubmitField
+
+from shopyo_ecommerce import productexcel
+
+
+class UploadProductForm(FlaskForm):
+    product_file = FileField(
+        "Product upload",
+        validators=[
+            FileAllowed(productexcel, "File must be in xls, xlsx, xlsm, xlsb, odf"),
+            FileRequired("File was empty!"),
+        ],
+        render_kw={
+            "class": "form-control",
+            "autocomplete": "off",
+            "id": "upload-product-input",
+        },
+    )

shopyo_ecommerce-0.1.0/shopyo_ecommerce/category/global.py

@@ -0,0 +1,8 @@
+from shopyo_ecommerce.category.models import Category
+
+
+def get_categories():
+    return Category.query.all()
+
+
+available_everywhere = {"get_categories": get_categories, "Category": Category}

shopyo_ecommerce-0.1.0/shopyo_ecommerce/category/info.json

@@ -0,0 +1,12 @@
+{
+    "display_string": "Inventory",
+    "module_name": "category",
+    "type": "show",
+    "icons": {
+        "fa": "fa fa-edit",
+        "boxicons": "bx bx-pen"
+    },
+    "url_prefix": "/category",
+    "dashboard": "/dashboard",
+    "fa-icon": "fas fa-cubes"
+}

shopyo_ecommerce-0.1.0/shopyo_ecommerce/category/models.py

@@ -0,0 +1,93 @@
+"""
+remember: backrefs should be unique
+"""
+
+from flask import url_for
+
+from shopyo.api.models import PkModel
+from sqlalchemy import exists
+from sqlalchemy.orm import validates
+
+from init import db
+
+
+class Category(PkModel):
+    __tablename__ = "shopyo_ecommerce_categories"
+    name = db.Column(db.String(100), unique=True, nullable=False)
+    subcategories = db.relationship("SubCategory", backref="category", lazy=True)
+    resources = db.relationship(
+        "Resource",
+        backref="resource_category",
+        lazy=True,
+    )
+
+    def __repr__(self):
+        return f"Category: {self.name}"
+
+    @classmethod
+    def category_exists(cls, name):
+        return db.session.query(exists().where(cls.name == name.lower())).scalar()
+
+    @validates("name")
+    def convert_lower(self, key, value):
+        return value.lower()
+
+    def get_num_subcategories(self):
+        return len(self.subcategories)
+ 
+    def get_one_image_url(self):
+        if len(self.resources) == 0:
+            return url_for("static", filename="default/default_subcategory.jpg")
+        else:
+            resource = self.resources[0]
+            return url_for("static", filename=f"uploads/products/{resource.filename}")
+
+    def get_page_url(self):
+        return url_for("shopyo_ecommerce.shop.category", category_name=self.name)
+
+
+class SubCategory(PkModel):
+    __tablename__ = "shopyo_ecommerce_subcategories"
+    name = db.Column(db.String(100), nullable=False)
+    category_id = db.Column(db.Integer, db.ForeignKey("shopyo_ecommerce_categories.id"))
+    products = db.relationship("Product", backref="subcategory", lazy=True)
+    resources = db.relationship("Resource", backref="resource_subcategory", lazy=True)
+
+    @classmethod
+    def category_exists(cls, name):
+        return db.session.query(exists().where(cls.name == name.lower())).scalar()
+
+    @validates("name")
+    def convert_lower(self, key, value):
+        return value.lower()
+
+    def get_num_products(self):
+        return len(self.products)
+
+    def get_one_image_url(self):
+
+        if len(self.products) > 0:
+            product = self.products[0]
+            if len(product.resources) == 0:
+                if len(self.resources) == 0:
+                    return url_for("static", filename="default/default_subcategory.jpg")
+                else:
+                    resource = self.resources[0]
+                    return url_for(
+                        "static",
+                        filename=f"uploads/subcategory/{resource.filename}",
+                    )
+            else:
+                resource = product.resources[0]
+                return url_for(
+                    "static", filename=f"uploads/products/{resource.filename}"
+                )
+        else:
+            if len(self.resources) == 0:
+                return url_for("static", filename="default/default_subcategory.jpg")
+            else:
+                resource = self.resources[0]
+                return url_for(
+                    "static",
+                    filename=f"uploads/subcategory/{resource.filename}",
+                )