unitysvc-services 0.1.1__tar.gz → 0.1.4__tar.gz

{unitysvc_services-0.1.1 → unitysvc_services-0.1.4}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: unitysvc-services
-Version: 0.1.1
+Version: 0.1.4
 Summary: SDK for digital service providers on UnitySVC
 Author-email: Bo Peng <bo.peng@unitysvc.com>
 Maintainer-email: Bo Peng <bo.peng@unitysvc.com>
-License: MIT
+License-Expression: MIT
 Project-URL: bugs, https://github.com/unitysvc/unitysvc-services/issues
 Project-URL: changelog, https://github.com/unitysvc/unitysvc-services/blob/master/changelog.md
 Project-URL: homepage, https://github.com/unitysvc/unitysvc-services
@@ -53,11 +53,11 @@ Client library and CLI tools for digital service providers to interact with the
 
 UnitySVC Provider SDK enables digital service 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
-- **Publish** to UnitySVC platform when ready
-- **Automate** with populate scripts for dynamic catalogs
+-   **Define** service data using schema-validated files (JSON/TOML)
+-   **Manage** everything locally in git-controlled directories
+-   **Validate** data against schemas before publishing
+-   **Publish** to UnitySVC platform when ready
+-   **Automate** with populate scripts for dynamic catalogs
 
 ## Installation
 
@@ -79,27 +79,29 @@ unitysvc_services init seller my-marketplace
 unitysvc_services validate
 unitysvc_services format
 
-# Publish to platform
-export UNITYSVC_BACKEND_URL="https://api.unitysvc.com/api/v1"
+# 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
-unitysvc_services publish sellers
-unitysvc_services publish offerings
-unitysvc_services publish listings
 
-# Verify
+# Verify with default fields
 unitysvc_services query offerings
+
+# Query with custom fields
+unitysvc_services query providers --fields id,name,contact_email
 ```
 
 ## Key Features
 
-- 📋 **Pydantic Models** - Type-safe data models for all entities
-- ✅ **Data Validation** - Comprehensive schema validation
-- 🔄 **Local-First** - Work offline, commit to git, publish when ready
-- 🚀 **CLI Tools** - Complete command-line interface
-- 🤖 **Automation** - Script-based service generation
-- 📝 **Multiple Formats** - Support for JSON and TOML
+-   📋 **Pydantic Models** - Type-safe data models for all entities
+-   ✅ **Data Validation** - Comprehensive schema validation
+-   🔄 **Local-First** - Work offline, commit to git, publish when ready
+-   🚀 **CLI Tools** - Complete command-line interface
+-   🤖 **Automation** - Script-based service generation
+-   📝 **Multiple Formats** - Support for JSON and TOML
 
 ## Workflows
 
@@ -135,34 +137,34 @@ 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      |
 
 Run `unitysvc_services --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
-- **[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
+-   **[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
+-   **[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
 
 ## Links
 
-- **PyPI**: https://pypi.org/project/unitysvc-services/
-- **Documentation**: https://unitysvc-services.readthedocs.io
-- **Source Code**: https://github.com/unitysvc/unitysvc-services
-- **Issue Tracker**: https://github.com/unitysvc/unitysvc-services/issues
+-   **PyPI**: https://pypi.org/project/unitysvc-services/
+-   **Documentation**: https://unitysvc-services.readthedocs.io
+-   **Source Code**: https://github.com/unitysvc/unitysvc-services
+-   **Issue Tracker**: https://github.com/unitysvc/unitysvc-services/issues
 
 ## License
 

{unitysvc_services-0.1.1 → unitysvc_services-0.1.4}/README.md

@@ -11,11 +11,11 @@ Client library and CLI tools for digital service providers to interact with the
 
 UnitySVC Provider SDK enables digital service 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
-- **Publish** to UnitySVC platform when ready
-- **Automate** with populate scripts for dynamic catalogs
+-   **Define** service data using schema-validated files (JSON/TOML)
+-   **Manage** everything locally in git-controlled directories
+-   **Validate** data against schemas before publishing
+-   **Publish** to UnitySVC platform when ready
+-   **Automate** with populate scripts for dynamic catalogs
 
 ## Installation
 
@@ -37,27 +37,29 @@ unitysvc_services init seller my-marketplace
 unitysvc_services validate
 unitysvc_services format
 
-# Publish to platform
-export UNITYSVC_BACKEND_URL="https://api.unitysvc.com/api/v1"
+# 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
-unitysvc_services publish sellers
-unitysvc_services publish offerings
-unitysvc_services publish listings
 
-# Verify
+# Verify with default fields
 unitysvc_services query offerings
+
+# Query with custom fields
+unitysvc_services query providers --fields id,name,contact_email
 ```
 
 ## Key Features
 
-- 📋 **Pydantic Models** - Type-safe data models for all entities
-- ✅ **Data Validation** - Comprehensive schema validation
-- 🔄 **Local-First** - Work offline, commit to git, publish when ready
-- 🚀 **CLI Tools** - Complete command-line interface
-- 🤖 **Automation** - Script-based service generation
-- 📝 **Multiple Formats** - Support for JSON and TOML
+-   📋 **Pydantic Models** - Type-safe data models for all entities
+-   ✅ **Data Validation** - Comprehensive schema validation
+-   🔄 **Local-First** - Work offline, commit to git, publish when ready
+-   🚀 **CLI Tools** - Complete command-line interface
+-   🤖 **Automation** - Script-based service generation
+-   📝 **Multiple Formats** - Support for JSON and TOML
 
 ## Workflows
 
@@ -93,34 +95,34 @@ 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      |
 
 Run `unitysvc_services --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
-- **[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
+-   **[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
+-   **[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
 
 ## Links
 
-- **PyPI**: https://pypi.org/project/unitysvc-services/
-- **Documentation**: https://unitysvc-services.readthedocs.io
-- **Source Code**: https://github.com/unitysvc/unitysvc-services
-- **Issue Tracker**: https://github.com/unitysvc/unitysvc-services/issues
+-   **PyPI**: https://pypi.org/project/unitysvc-services/
+-   **Documentation**: https://unitysvc-services.readthedocs.io
+-   **Source Code**: https://github.com/unitysvc/unitysvc-services
+-   **Issue Tracker**: https://github.com/unitysvc/unitysvc-services/issues
 
 ## License
 

{unitysvc_services-0.1.1 → unitysvc_services-0.1.4}/docs/api-reference.md

@@ -26,14 +26,17 @@ data, file_format = load_data_file(Path("data/my-provider/provider.json"))
 ```
 
 **Parameters:**
-- `file_path` (Path): Path to the data file
+
+-   `file_path` (Path): Path to the data file
 
 **Returns:**
-- `tuple[dict[str, Any], str]`: Data dictionary and format ("json" or "toml")
+
+-   `tuple[dict[str, Any], str]`: Data dictionary and format ("json" or "toml")
 
 **Raises:**
-- `ValueError`: If file format is not supported
-- `FileNotFoundError`: If file doesn't exist
+
+-   `ValueError`: If file format is not supported
+-   `FileNotFoundError`: If file doesn't exist
 
 #### write_data_file()
 
@@ -48,12 +51,14 @@ write_data_file(Path("data/my-provider/provider.json"), data, "json")
 ```
 
 **Parameters:**
-- `file_path` (Path): Path to write to
-- `data` (dict): Data to write
-- `file_format` (str): Format ("json" or "toml")
+
+-   `file_path` (Path): Path to write to
+-   `data` (dict): Data to write
+-   `file_format` (str): Format ("json" or "toml")
 
 **Returns:**
-- `None`
+
+-   `None`
 
 #### find_data_files()
 
@@ -68,10 +73,12 @@ files = find_data_files(Path("data"))
 ```
 
 **Parameters:**
-- `data_dir` (Path): Directory to search
+
+-   `data_dir` (Path): Directory to search
 
 **Returns:**
-- `list[Path]`: List of data file paths
+
+-   `list[Path]`: List of data file paths
 
 #### find_files_by_schema()
 
@@ -90,12 +97,14 @@ service_files = find_files_by_schema(
 ```
 
 **Parameters:**
-- `data_dir` (Path): Directory to search
-- `schema` (str): Schema to match (e.g., "service_v1")
-- `field_filter` (dict, optional): Additional field filters
+
+-   `data_dir` (Path): Directory to search
+-   `schema` (str): Schema to match (e.g., "service_v1")
+-   `field_filter` (dict, optional): Additional field filters
 
 **Returns:**
-- `list[tuple[Path, dict]]`: List of (file_path, data) tuples
+
+-   `list[tuple[Path, dict]]`: List of (file_path, data) tuples
 
 #### find_file_by_schema_and_name()
 
@@ -121,13 +130,15 @@ else:
 ```
 
 **Parameters:**
-- `data_dir` (Path): Directory to search
-- `schema` (str): Schema to match
-- `name_field` (str): Field name to match (e.g., "name")
-- `name_value` (str): Field value to match
+
+-   `data_dir` (Path): Directory to search
+-   `schema` (str): Schema to match
+-   `name_field` (str): Field name to match (e.g., "name")
+-   `name_value` (str): Field value to match
 
 **Returns:**
-- `tuple[Path, str, dict] | None`: (file_path, format, data) or None if not found
+
+-   `tuple[Path, str, dict] | None`: (file_path, format, data) or None if not found
 
 ### unitysvc_services.cli
 
@@ -165,11 +176,13 @@ client = get_api_client(
 ```
 
 **Parameters:**
-- `backend_url` (str): Backend API URL
-- `api_key` (str): API authentication key
+
+-   `backend_url` (str): Backend API URL
+-   `api_key` (str): API authentication key
 
 **Returns:**
-- `AuthenticatedClient`: Configured API client
+
+-   `AuthenticatedClient`: Configured API client
 
 #### publish_provider()
 
@@ -186,16 +199,19 @@ success = publish_provider(
 ```
 
 **Parameters:**
-- `client` (AuthenticatedClient): API client
-- `provider_file` (Path): Path to provider file
+
+-   `client` (AuthenticatedClient): API client
+-   `provider_file` (Path): Path to provider file
 
 **Returns:**
-- `bool`: True if successful
+
+-   `bool`: True if successful
 
 Similar functions exist for:
-- `publish_seller()`
-- `publish_offering()`
-- `publish_listing()`
+
+-   `publish_seller()`
+-   `publish_offering()`
+-   `publish_listing()`
 
 ### unitysvc_services.validator
 
@@ -217,18 +233,21 @@ if not is_valid:
 ```
 
 **Parameters:**
-- `data_dir` (Path): Directory to validate
+
+-   `data_dir` (Path): Directory to validate
 
 **Returns:**
-- `tuple[bool, list[str]]`: (is_valid, list of error messages)
+
+-   `tuple[bool, list[str]]`: (is_valid, list of error messages)
 
 **Validation checks:**
-- Schema compliance
-- Required fields present
-- Name uniqueness
-- Directory name matching
-- Valid references
-- File path validity
+
+-   Schema compliance
+-   Required fields present
+-   Name uniqueness
+-   Directory name matching
+-   Valid references
+-   File path validity
 
 ### unitysvc_services.formatter
 
@@ -252,17 +271,20 @@ for file_path in modified_files:
 ```
 
 **Parameters:**
-- `data_dir` (Path): Directory to format
-- `check_only` (bool): If True, don't modify files
+
+-   `data_dir` (Path): Directory to format
+-   `check_only` (bool): If True, don't modify files
 
 **Returns:**
-- `list[Path]`: List of modified (or would-be modified) files
+
+-   `list[Path]`: List of modified (or would-be modified) files
 
 **Formatting rules:**
-- JSON: 2-space indentation, sorted keys
-- TOML: Standard formatting
-- Remove trailing whitespace
-- Single newline at end of file
+
+-   JSON: 2-space indentation, sorted keys
+-   TOML: Standard formatting
+-   Remove trailing whitespace
+-   Single newline at end of file
 
 ### unitysvc_services.populator
 
@@ -288,12 +310,14 @@ for provider, success, output in results:
 ```
 
 **Parameters:**
-- `data_dir` (Path): Data directory
-- `provider_filter` (str, optional): Run for specific provider only
-- `dry_run` (bool): If True, don't actually execute
+
+-   `data_dir` (Path): Data directory
+-   `provider_filter` (str, optional): Run for specific provider only
+-   `dry_run` (bool): If True, don't actually execute
 
 **Returns:**
-- `list[tuple[str, bool, str]]`: List of (provider_name, success, output)
+
+-   `list[tuple[str, bool, str]]`: List of (provider_name, success, output)
 
 ## Pydantic Models
 
@@ -358,11 +382,8 @@ The SDK respects these environment variables:
 ```python
 import os
 
-# Data directory
-data_dir = os.getenv("UNITYSVC_DATA_DIR", "./data")
-
 # Backend connection
-backend_url = os.getenv("UNITYSVC_BACKEND_URL", "https://api.unitysvc.com/api/v1")
+backend_url = os.getenv("UNITYSVC_BASE_URL", "https://api.unitysvc.com/api/v1")
 api_key = os.getenv("UNITYSVC_API_KEY")
 ```
 
@@ -502,6 +523,6 @@ def get_service(name: str, data_dir: Path = Path("data")) -> dict[str, Any] | No
 
 ## See Also
 
-- [CLI Reference](cli-reference.md) - Command-line interface
-- [File Schemas](file-schemas.md) - Data schema specifications
-- [Workflows](workflows.md) - Usage patterns and examples
+-   [CLI Reference](cli-reference.md) - Command-line interface
+-   [File Schemas](file-schemas.md) - Data schema specifications
+-   [Workflows](workflows.md) - Usage patterns and examples