unitysvc-services 0.2.4__tar.gz → 0.2.6__tar.gz

{unitysvc_services-0.2.4/src/unitysvc_services.egg-info → unitysvc_services-0.2.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: unitysvc-services
-Version: 0.2.4
+Version: 0.2.6
 Summary: SDK for digital service providers on UnitySVC
 Author-email: Bo Peng <bo.peng@unitysvc.com>
 Maintainer-email: Bo Peng <bo.peng@unitysvc.com>

{unitysvc_services-0.2.4 → unitysvc_services-0.2.6}/docs/data-structure.md

@@ -80,6 +80,13 @@ data/
 - Location: `${provider_name}/services/${service_name}/listing-*.json`
 - Both offerings and listings are defined in the same service directory under the provider
 
+#### Multiple Listings Per Service
+When a single service offering has multiple listings (e.g., different pricing tiers, different marketplaces), the filename becomes significant:
+
+- **Filename as identifier**: If the `name` field is not provided in the listing file, the filename (without extension) is automatically used as the listing name
+- **Example**: `listing-premium.json`, `listing-basic.json`, `listing-enterprise.json` for different tiers
+- **Best practice**: Use descriptive filenames that indicate the listing variant, or explicitly set the `name` field in each file
+
 ### 7. External Files (Documentation, Code Examples, etc.)
 - External files like code examples, documentation, images can be placed anywhere in the directory structure
 - They are referenced by **relative paths** from the referencing file
@@ -181,10 +188,11 @@ data/
 │   └── services/
 │       ├── gpt-4/                       # Service: "gpt-4"
 │       │   ├── service.json             # name = "gpt-4"
-│       │   └── listing-svcreseller.json # seller_name = "svcreseller"
+│       │   ├── listing-premium.json     # name = "listing-premium" (or defaults to filename)
+│       │   └── listing-basic.json       # name = "listing-basic" (multiple listings for one service)
 │       └── gpt-3.5-turbo/              # Service: "gpt-3.5-turbo"
 │           ├── service.json             # name = "gpt-3.5-turbo"
-│           └── listing-svcreseller.json
+│           └── listing-svcreseller.json # Single listing
 └── anthropic/                           # Provider: "anthropic"
     ├── provider.json                    # name = "anthropic"
     └── services/

{unitysvc_services-0.2.4 → unitysvc_services-0.2.6}/docs/file-schemas.md

@@ -194,6 +194,7 @@ Listing files define how a seller presents/sells a service (downstream/marketpla
 | Field | Type | Description |
 |-------|------|-------------|
 | `schema` | string | Must be `"listing_v1"` |
+| `name` | string | Listing identifier (defaults to filename without extension if not provided) |
 | `seller_name` | string | Seller identifier (references seller file) |
 | `listing_status` | string | Listing status (see Status Values) |
 
@@ -209,6 +210,15 @@ Listing files define how a seller presents/sells a service (downstream/marketpla
 | `documents` | array | Documentation files |
 | `tags` | array | Search/filter tags |
 
+### Listing Name Field
+
+The `name` field identifies the listing and is especially important when multiple listings exist for a single service offering:
+
+- **Automatic naming**: If the `name` field is not provided, the SDK automatically uses the filename (without extension) as the listing name
+- **Multiple listings**: When you have multiple listings for one service (e.g., different tiers or marketplaces), use descriptive filenames
+- **Example**: A file named `listing-premium.json` will automatically get `name = "listing-premium"` if the field is omitted
+- **Best practice**: Use explicit `name` fields for clarity, or use descriptive filenames that will serve as meaningful listing identifiers
+
 ### listing_status Values
 
 - `unknown` - Status not yet determined
@@ -223,6 +233,7 @@ Listing files define how a seller presents/sells a service (downstream/marketpla
 
 ```toml
 schema = "listing_v1"
+name = "listing-premium"
 seller_name = "svcreseller"
 service_name = "gpt-4"
 listing_status = "in_service"

{unitysvc_services-0.2.4 → unitysvc_services-0.2.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "unitysvc-services"
-version = "0.2.4"
+version = "0.2.6"
 description = "SDK for digital service providers on UnitySVC"
 readme = "README.md"
 authors = [{ name = "Bo Peng", email = "bo.peng@unitysvc.com" }]

{unitysvc_services-0.2.4 → unitysvc_services-0.2.6}/src/unitysvc_services/models/listing_v1.py

@@ -3,12 +3,7 @@ from typing import Any
 
 from pydantic import BaseModel, ConfigDict, Field
 
-from unitysvc_services.models.base import (
-    AccessInterface,
-    Document,
-    ListingStatusEnum,
-    Pricing,
-)
+from unitysvc_services.models.base import AccessInterface, Document, ListingStatusEnum, Pricing
 
 
 class ListingV1(BaseModel):
@@ -32,6 +27,11 @@ class ListingV1(BaseModel):
 
     seller_name: str | None = Field(default=None, description="Name of the seller offering this service listing")
 
+    name: str | None = Field(
+        default=None,
+        max_length=255,
+        description="Name identifier for the service listing, default to filename",
+    )
     # unique name for each provider, usually following upstream naming convention
     # status of the service, public, deprecated etc
     listing_status: ListingStatusEnum = Field(

{unitysvc_services-0.2.4 → unitysvc_services-0.2.6}/src/unitysvc_services/publisher.py

@@ -159,6 +159,10 @@ class ServiceDataPublisher:
         # Load the listing data file
         data = self.load_data_file(data_file)
 
+        # If name is not provided, use filename (without extension)
+        if "name" not in data or not data.get("name"):
+            data["name"] = data_file.stem
+
         # Resolve file references and include content
         base_path = data_file.parent
         data_with_content = self.resolve_file_references(data, base_path)

{unitysvc_services-0.2.4 → unitysvc_services-0.2.6}/src/unitysvc_services/query.py

@@ -46,10 +46,7 @@ class ServiceDataQuery:
             skip: Number of records to skip (for pagination)
             limit: Maximum number of records to return
         """
-        response = self.client.get(
-            f"{self.base_url}/publish/offerings",
-            params={"skip": skip, "limit": limit}
-        )
+        response = self.client.get(f"{self.base_url}/publish/offerings", params={"skip": skip, "limit": limit})
         response.raise_for_status()
         result = response.json()
         return result.get("data", result) if isinstance(result, dict) else result
@@ -61,10 +58,7 @@ class ServiceDataQuery:
             skip: Number of records to skip (for pagination)
             limit: Maximum number of records to return
         """
-        response = self.client.get(
-            f"{self.base_url}/publish/listings",
-            params={"skip": skip, "limit": limit}
-        )
+        response = self.client.get(f"{self.base_url}/publish/listings", params={"skip": skip, "limit": limit})
         response.raise_for_status()
         result = response.json()
         return result.get("data", result) if isinstance(result, dict) else result
@@ -76,10 +70,7 @@ class ServiceDataQuery:
             skip: Number of records to skip (for pagination)
             limit: Maximum number of records to return
         """
-        response = self.client.get(
-            f"{self.base_url}/publish/providers",
-            params={"skip": skip, "limit": limit}
-        )
+        response = self.client.get(f"{self.base_url}/publish/providers", params={"skip": skip, "limit": limit})
         response.raise_for_status()
         result = response.json()
         return result.get("data", result) if isinstance(result, dict) else result
@@ -91,10 +82,7 @@ class ServiceDataQuery:
             skip: Number of records to skip (for pagination)
             limit: Maximum number of records to return
         """
-        response = self.client.get(
-            f"{self.base_url}/publish/sellers",
-            params={"skip": skip, "limit": limit}
-        )
+        response = self.client.get(f"{self.base_url}/publish/sellers", params={"skip": skip, "limit": limit})
         response.raise_for_status()
         result = response.json()
         return result.get("data", result) if isinstance(result, dict) else result
@@ -590,7 +578,7 @@ def query_listings(
 
         # Show all available fields
         unitysvc_services query listings --fields \\
-            id,service_name,service_type,seller_name,listing_type,status,provider_name
+            id,name,service_name,service_type,seller_name,listing_type,status,provider_name
     """
     # Parse fields list
     field_list = [f.strip() for f in fields.split(",")]
@@ -598,6 +586,7 @@ def query_listings(
     # Define allowed fields from ServiceListingPublic model
     allowed_fields = {
         "id",
+        "name",
         "offering_id",
         "offering_status",
         "seller_id",

{unitysvc_services-0.2.4 → unitysvc_services-0.2.6/src/unitysvc_services.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: unitysvc-services
-Version: 0.2.4
+Version: 0.2.6
 Summary: SDK for digital service providers on UnitySVC
 Author-email: Bo Peng <bo.peng@unitysvc.com>
 Maintainer-email: Bo Peng <bo.peng@unitysvc.com>