unitysvc-services 0.1.4__py3-none-any.whl → 0.1.5__py3-none-any.whl

unitysvc_services/utils.py

@@ -7,6 +7,7 @@ from pathlib import Path
 from typing import Any
 
 import tomli_w
+from jinja2 import Template
 
 
 def load_data_file(file_path: Path) -> tuple[dict[str, Any], str]:
@@ -336,3 +337,55 @@ def convert_convenience_fields_to_documents(
         del data[terms_field]
 
     return data
+
+
+def render_template_file(
+    file_path: Path,
+    listing: dict[str, Any] | None = None,
+    offering: dict[str, Any] | None = None,
+    provider: dict[str, Any] | None = None,
+    seller: dict[str, Any] | None = None,
+) -> tuple[str, str]:
+    """Render a Jinja2 template file and return content and new filename.
+
+    If the file is not a template (.j2 extension), returns the file content as-is
+    and the original filename.
+
+    Args:
+        file_path: Path to the file (may or may not be a .j2 template)
+        listing: Listing data for template rendering (optional)
+        offering: Offering data for template rendering (optional)
+        provider: Provider data for template rendering (optional)
+        seller: Seller data for template rendering (optional)
+
+    Returns:
+        Tuple of (rendered_content, new_filename_without_j2)
+
+    Raises:
+        Exception: If template rendering fails
+    """
+    # Read file content
+    with open(file_path, encoding="utf-8") as f:
+        file_content = f.read()
+
+    # Check if this is a Jinja2 template
+    is_template = file_path.name.endswith(".j2")
+
+    if is_template:
+        # Render the template
+        template = Template(file_content)
+        rendered_content = template.render(
+            listing=listing or {},
+            offering=offering or {},
+            provider=provider or {},
+            seller=seller or {},
+        )
+
+        # Strip .j2 from filename
+        # Example: test.py.j2 -> test.py
+        new_filename = file_path.name[:-3]  # Remove last 3 characters (.j2)
+
+        return rendered_content, new_filename
+    else:
+        # Not a template - return as-is
+        return file_content, file_path.name

unitysvc_services/validator.py

@@ -322,8 +322,15 @@ class DataValidator:
 
         return len(errors) == 0, errors
 
-    def validate_md_file(self, file_path: Path) -> tuple[bool, list[str]]:
-        """Validate a markdown file (basic existence check and Jinja2 syntax)."""
+    def validate_jinja2_file(self, file_path: Path) -> tuple[bool, list[str]]:
+        """Validate a file with Jinja2 template syntax.
+
+        This validates any file ending with .j2 extension, including:
+        - .md.j2 (Jinja2 markdown templates)
+        - .py.j2 (Jinja2 Python code example templates)
+        - .js.j2 (Jinja2 JavaScript code example templates)
+        - .sh.j2 (Jinja2 shell script templates)
+        """
         errors: list[str] = []
 
         try:
@@ -344,7 +351,7 @@ class DataValidator:
 
             return len(errors) == 0, errors
         except Exception as e:
-            return False, [f"Failed to read markdown file: {e}"]
+            return False, [f"Failed to read template file: {e}"]
 
     def validate_seller_uniqueness(self) -> tuple[bool, list[str]]:
         """
@@ -502,13 +509,18 @@ class DataValidator:
             if any(part.startswith(".") for part in file_path.parts):
                 continue
 
-            if file_path.is_file() and file_path.suffix in [".json", ".toml", ".md"]:
+            # Check if file should be validated
+            # Only .j2 files (Jinja2 templates) are validated for Jinja2 syntax
+            is_template = file_path.name.endswith(".j2")
+            is_data_file = file_path.suffix in [".json", ".toml"]
+
+            if file_path.is_file() and (is_data_file or is_template):
                 relative_path = file_path.relative_to(self.data_dir)
 
-                if file_path.suffix in [".json", ".toml"]:
+                if is_data_file:
                     is_valid, errors = self.validate_data_file(file_path)
-                elif file_path.suffix == ".md":
-                    is_valid, errors = self.validate_md_file(file_path)
+                elif is_template:
+                    is_valid, errors = self.validate_jinja2_file(file_path)
                 else:
                     continue
 

{unitysvc_services-0.1.4.dist-info → unitysvc_services-0.1.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: unitysvc-services
-Version: 0.1.4
+Version: 0.1.5
 Summary: SDK for digital service providers on UnitySVC
 Author-email: Bo Peng <bo.peng@unitysvc.com>
 Maintainer-email: Bo Peng <bo.peng@unitysvc.com>
@@ -40,22 +40,23 @@ Requires-Dist: mkdocs-material; extra == "docs"
 Requires-Dist: mkdocs-autorefs; extra == "docs"
 Dynamic: license-file
 
-# UnitySVC Provider SDK
+# UnitySVC Services SDK
 
 ![PyPI version](https://img.shields.io/pypi/v/unitysvc-services.svg)
 [![Documentation Status](https://readthedocs.org/projects/unitysvc-services/badge/?version=latest)](https://unitysvc-services.readthedocs.io/en/latest/?version=latest)
 
-Client library and CLI tools for digital service providers to interact with the UnitySVC platform.
+Client library and CLI tools for sellers and providers of digital service to interact with the UnitySVC platform.
 
 **📚 [Full Documentation](https://unitysvc-services.readthedocs.io)** | **🚀 [Getting Started](https://unitysvc-services.readthedocs.io/en/latest/getting-started/)** | **📖 [CLI Reference](https://unitysvc-services.readthedocs.io/en/latest/cli-reference/)**
 
 ## Overview
 
-UnitySVC Provider SDK enables digital service providers to manage their service offerings through a **local-first, version-controlled workflow**:
+UnitySVC Services SDK enables digital service sellers and providers to manage their service offerings through a **local-first, version-controlled workflow**:
 
 -   **Define** service data using schema-validated files (JSON/TOML)
 -   **Manage** everything locally in git-controlled directories
--   **Validate** data against schemas before publishing
+-   **Validate** data against schemas
+-   **Test** code examples using provider credentials
 -   **Publish** to UnitySVC platform when ready
 -   **Automate** with populate scripts for dynamic catalogs
 
@@ -67,31 +68,34 @@ pip install unitysvc-services
 
 Requires Python 3.11+
 
+**CLI Alias:** The command `unitysvc_services` can also be invoked using the shorter alias `usvc`.
+
 ## Quick Example
 
 ```bash
-# Initialize provider and service
-unitysvc_services init provider my-provider
-unitysvc_services init offering my-service
-unitysvc_services init seller my-marketplace
+# Initialize provider and service (using short alias 'usvc')
+usvc init provider my-provider
+usvc init offering my-service
+usvc init seller my-marketplace
 
 # Validate and format
-unitysvc_services validate
-unitysvc_services format
+usvc validate
+usvc format
+
+# Test code examples with upstream credentials
+usvc test list --provider fireworks
+usvc test run --provider fireworks --services "llama*"
+
+# if you write a script to manage services
+usvc populate
 
 # Publish to platform (publishes all: sellers, providers, offerings, listings)
 export UNITYSVC_BASE_URL="https://api.unitysvc.com/api/v1"
 export UNITYSVC_API_KEY="your-api-key"
-unitysvc_services publish
-
-# Or publish specific types only
-unitysvc_services publish providers
-
-# Verify with default fields
-unitysvc_services query offerings
+usvc publish
 
-# Query with custom fields
-unitysvc_services query providers --fields id,name,contact_email
+# Query unitysvc backend to verify data
+usvc query providers --fields id,name,contact_email
 ```
 
 ## Key Features
@@ -108,13 +112,13 @@ unitysvc_services query providers --fields id,name,contact_email
 ### Manual Workflow (small catalogs)
 
 ```bash
-init → edit files → validate → format → publish → verify
+init → edit files → validate → test → format → publish → verify
 ```
 
 ### Automated Workflow (large/dynamic catalogs)
 
 ```bash
-init provider → configure populate script → populate → validate → publish
+init → configure populate script → populate → validate → publish
 ```
 
 See [Workflows Documentation](https://unitysvc-services.readthedocs.io/en/latest/workflows/) for details.
@@ -137,24 +141,27 @@ See [Data Structure Documentation](https://unitysvc-services.readthedocs.io/en/l
 
 ## CLI Commands
 
-| Command    | Description                            |
-| ---------- | -------------------------------------- |
-| `init`     | Initialize new data files from schemas |
-| `list`     | List local data files                  |
-| `query`    | Query backend API for published data   |
-| `publish`  | Publish data to backend                |
-| `update`   | Update local file fields               |
-| `validate` | Validate data consistency              |
-| `format`   | Format data files                      |
-| `populate` | Execute provider populate scripts      |
+| Command    | Description                                      |
+| ---------- | ------------------------------------------------ |
+| `init`     | Initialize new data files from schemas           |
+| `list`     | List local data files                            |
+| `query`    | Query backend API for published data             |
+| `publish`  | Publish data to backend                          |
+| `update`   | Update local file fields                         |
+| `validate` | Validate data consistency                        |
+| `format`   | Format data files                                |
+| `populate` | Execute provider populate scripts                |
+| `test`     | Test code examples with upstream API credentials |
 
-Run `unitysvc_services --help` or see [CLI Reference](https://unitysvc-services.readthedocs.io/en/latest/cli-reference/) for complete documentation.
+Run `usvc --help` or see [CLI Reference](https://unitysvc-services.readthedocs.io/en/latest/cli-reference/) for complete documentation.
 
 ## Documentation
 
 -   **[Getting Started](https://unitysvc-services.readthedocs.io/en/latest/getting-started/)** - Installation and first steps
 -   **[Data Structure](https://unitysvc-services.readthedocs.io/en/latest/data-structure/)** - File organization rules
 -   **[Workflows](https://unitysvc-services.readthedocs.io/en/latest/workflows/)** - Manual and automated patterns
+-   **[Documenting Service Listings](https://unitysvc-services.readthedocs.io/en/latest/documenting-services/)** - Add documentation to services
+-   **[Creating Code Examples](https://unitysvc-services.readthedocs.io/en/latest/code-examples/)** - Develop and test code examples
 -   **[CLI Reference](https://unitysvc-services.readthedocs.io/en/latest/cli-reference/)** - All commands and options
 -   **[File Schemas](https://unitysvc-services.readthedocs.io/en/latest/file-schemas/)** - Schema specifications
 -   **[Python API](https://unitysvc-services.readthedocs.io/en/latest/api-reference/)** - Programmatic usage

unitysvc_services-0.1.5.dist-info/RECORD

@@ -0,0 +1,26 @@
+unitysvc_services/__init__.py,sha256=J6F3RlZCJUVjhZoprfbrYCxe3l9ynQQbGO7pf7FyqlM,110
+unitysvc_services/api.py,sha256=d3xY4ElA4aCAl62xrwjZ6qIWUoYT-4Q8wJ8BJbyZzXI,11990
+unitysvc_services/cli.py,sha256=omHzrWk8iZJUjZTE5KCmEK1wnRGGnQk_BNV-hKqucnA,725
+unitysvc_services/format_data.py,sha256=Jl9Vj3fRX852fHSUa5DzO-oiFQwuQHC3WMCDNIlo1Lc,5460
+unitysvc_services/list.py,sha256=QDp9BByaoeFeJxXJN9RQ-jU99mH9Guq9ampfXCbpZmI,7033
+unitysvc_services/populate.py,sha256=jiqS2D3_widV6siPe3OBvw7ZdG9MuddEIOuTUCtMM5c,7605
+unitysvc_services/publisher.py,sha256=mKlY7-zEP8dtldcO8DJtbXVrdOACZCYsu49yP2iSD4w,53855
+unitysvc_services/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+unitysvc_services/query.py,sha256=q0_g5YAl9cPlHpW7k7Y6A-t4fQSdI-_4Jl6g2KgkEm0,24049
+unitysvc_services/scaffold.py,sha256=Y73IX8vskImxSvxDgR0mvEFuAMYnBKfttn3bjcz3jmQ,40331
+unitysvc_services/test.py,sha256=ZwWr2WCfzRBY39tuijK5P2v0VZ7PXwg3tFtJkTOsGrU,28341
+unitysvc_services/update.py,sha256=K9swocTUnqqiSgARo6GmuzTzUySSpyqqPPW4xF7ZU-g,9659
+unitysvc_services/utils.py,sha256=9htuxyzEjjbbAi704td9mOrtPzSOJzY46ALuup6bJW0,13093
+unitysvc_services/validator.py,sha256=sasMpdDhoWZJZ-unrnDhaJfyxHSm3IgQjEdmPvXrFEE,29525
+unitysvc_services/models/__init__.py,sha256=hJCc2KSZmIHlKWKE6GpLGdeVB6LIpyVUKiOKnwmKvCs,200
+unitysvc_services/models/base.py,sha256=cSxOYs_YSrqkQLBKIGVZmK627MyMft7cDn0WnrQlzPM,18736
+unitysvc_services/models/listing_v1.py,sha256=PPb9hIdWQp80AWKLxFXYBDcWXzNcDrO4v6rqt5_i2qo,3083
+unitysvc_services/models/provider_v1.py,sha256=76EK1i0hVtdx_awb00-ZMtSj4Oc9Zp4xZ-DeXmG3iTY,2701
+unitysvc_services/models/seller_v1.py,sha256=oll2ZZBPBDX8wslHrbsCKf_jIqHNte2VEj5RJ9bawR4,3520
+unitysvc_services/models/service_v1.py,sha256=Xpk-K-95M1LRqYM8nNJcll8t-lsW9Xdi2_bVbYNs8-M,3019
+unitysvc_services-0.1.5.dist-info/licenses/LICENSE,sha256=_p8V6A8OMPu2HIztn3O01v0-urZFwk0Dd3Yk_PTIlL8,1065
+unitysvc_services-0.1.5.dist-info/METADATA,sha256=LZrIRYvKsl0t2mptoidJVkjOeNJFbx_a-QgUxEJLsgY,7234
+unitysvc_services-0.1.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+unitysvc_services-0.1.5.dist-info/entry_points.txt,sha256=RBhVHKky3rsOly4jVa29c7UAw5ZwNNWnttmtzozr5O0,97
+unitysvc_services-0.1.5.dist-info/top_level.txt,sha256=GIotQj-Ro2ruR7eupM1r58PWqIHTAq647ORL7E2kneo,18
+unitysvc_services-0.1.5.dist-info/RECORD,,

{unitysvc_services-0.1.4.dist-info → unitysvc_services-0.1.5.dist-info}/entry_points.txt

@@ -1,2 +1,3 @@
 [console_scripts]
 unitysvc_services = unitysvc_services.cli:app
+usvc = unitysvc_services.cli:app

unitysvc_services-0.1.4.dist-info/RECORD

@@ -1,25 +0,0 @@
-unitysvc_services/__init__.py,sha256=J6F3RlZCJUVjhZoprfbrYCxe3l9ynQQbGO7pf7FyqlM,110
-unitysvc_services/api.py,sha256=FKIid1gUJcEcN_4P9d5-SgmJfW73WHBg5wXsVHeqNHQ,9888
-unitysvc_services/cli.py,sha256=OK0IZyAckxP15jRWU_W49hl3t7XcNRtd8BoDMyRKqNM,682
-unitysvc_services/format_data.py,sha256=Jl9Vj3fRX852fHSUa5DzO-oiFQwuQHC3WMCDNIlo1Lc,5460
-unitysvc_services/list.py,sha256=QDp9BByaoeFeJxXJN9RQ-jU99mH9Guq9ampfXCbpZmI,7033
-unitysvc_services/populate.py,sha256=zkcjIy8BWuQSO7JwiRNHKgGoxQvc3ujluUQdYixdBvY,6626
-unitysvc_services/publisher.py,sha256=dkufYcuBJ0dDoTQJm7BMOug_Pr2RyXMVI8nvZjy-zdM,50420
-unitysvc_services/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-unitysvc_services/query.py,sha256=2Rn6gioAN3W6KIumVzCpSJXzhJLJUDLkDla_GVwNx9I,24793
-unitysvc_services/scaffold.py,sha256=Y73IX8vskImxSvxDgR0mvEFuAMYnBKfttn3bjcz3jmQ,40331
-unitysvc_services/update.py,sha256=K9swocTUnqqiSgARo6GmuzTzUySSpyqqPPW4xF7ZU-g,9659
-unitysvc_services/utils.py,sha256=GN0gkVTU8fOx2G0EbqnWmx8w9eFsoPfRprPjwCyPYkE,11371
-unitysvc_services/validator.py,sha256=VAII5mu_Jdyr96v4nwXzihsoAj7DJiXN6LjhL8lGGUo,29054
-unitysvc_services/models/__init__.py,sha256=hJCc2KSZmIHlKWKE6GpLGdeVB6LIpyVUKiOKnwmKvCs,200
-unitysvc_services/models/base.py,sha256=3FdlR-_tBOFC2JbVNFNQA4-D1Lhlo5UZQh1QDgKnS_I,18293
-unitysvc_services/models/listing_v1.py,sha256=PPb9hIdWQp80AWKLxFXYBDcWXzNcDrO4v6rqt5_i2qo,3083
-unitysvc_services/models/provider_v1.py,sha256=76EK1i0hVtdx_awb00-ZMtSj4Oc9Zp4xZ-DeXmG3iTY,2701
-unitysvc_services/models/seller_v1.py,sha256=oll2ZZBPBDX8wslHrbsCKf_jIqHNte2VEj5RJ9bawR4,3520
-unitysvc_services/models/service_v1.py,sha256=Xpk-K-95M1LRqYM8nNJcll8t-lsW9Xdi2_bVbYNs8-M,3019
-unitysvc_services-0.1.4.dist-info/licenses/LICENSE,sha256=_p8V6A8OMPu2HIztn3O01v0-urZFwk0Dd3Yk_PTIlL8,1065
-unitysvc_services-0.1.4.dist-info/METADATA,sha256=7LiJhVwEw0fL72bOWwX7kU5KjQ-PDmt23CD4FgEI8YU,6628
-unitysvc_services-0.1.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-unitysvc_services-0.1.4.dist-info/entry_points.txt,sha256=-vodnbPmo7QQmFu8jdG6sCyGRVM727w9Nhwp4Vwau_k,64
-unitysvc_services-0.1.4.dist-info/top_level.txt,sha256=GIotQj-Ro2ruR7eupM1r58PWqIHTAq647ORL7E2kneo,18
-unitysvc_services-0.1.4.dist-info/RECORD,,