unitysvc-services 0.1.24__py3-none-any.whl

unitysvc_services-0.1.24.dist-info/METADATA

@@ -0,0 +1,184 @@
+Metadata-Version: 2.4
+Name: unitysvc-services
+Version: 0.1.24
+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-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
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer
+Requires-Dist: pydantic
+Requires-Dist: email-validator
+Requires-Dist: jsonschema
+Requires-Dist: jinja2
+Requires-Dist: rich
+Requires-Dist: httpx
+Requires-Dist: tomli-w
+Provides-Extra: test
+Requires-Dist: coverage; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: ruff; extra == "test"
+Requires-Dist: mypy; extra == "test"
+Requires-Dist: ipdb; extra == "test"
+Provides-Extra: dev
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: ty; extra == "dev"
+Requires-Dist: ipdb; extra == "dev"
+Requires-Dist: mkdocs; extra == "dev"
+Requires-Dist: mkdocs-material; extra == "dev"
+Requires-Dist: mkdocs-autorefs; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs; extra == "docs"
+Requires-Dist: mkdocs-material; extra == "docs"
+Requires-Dist: mkdocs-autorefs; extra == "docs"
+Dynamic: license-file
+
+# 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 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 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
+-   **Test** code examples using provider credentials
+-   **Publish** to UnitySVC platform when ready
+-   **Automate** with populate scripts for dynamic catalogs
+
+## Installation
+
+```bash
+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 (using short alias 'usvc')
+usvc init provider my-provider
+usvc init offering my-service
+usvc init seller my-marketplace
+
+# Validate and 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"
+usvc publish
+
+# Query unitysvc backend to verify data
+usvc 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
+-   🎯 **Smart Routing** - Request routing based on routing keys (e.g., model-specific endpoints)
+
+## Workflows
+
+### Manual Workflow (small catalogs)
+
+```bash
+init → edit files → validate → test → format → publish → verify
+```
+
+### Automated Workflow (large/dynamic catalogs)
+
+```bash
+init → configure populate script → populate → validate → publish
+```
+
+See [Workflows Documentation](https://unitysvc-services.readthedocs.io/en/latest/workflows/) for details.
+
+## Data Structure
+
+```
+data/
+├── seller.json                    # One seller per repo
+├── ${provider_name}/
+│   ├── provider.json              # Provider metadata
+│   ├── docs/                      # Shared documentation
+│   └── services/
+│       └── ${service_name}/
+│           ├── service.json       # Service offering
+│           └── listing-*.json     # Service listing(s)
+```
+
+See [Data Structure Documentation](https://unitysvc-services.readthedocs.io/en/latest/data-structure/) for complete details.
+
+## 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                          |
+| `unpublish` | Unpublish (delete) data from 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 `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
+
+## 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
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file for details.
+
+## Contributing
+
+Contributions welcome! See [Contributing Guide](https://unitysvc-services.readthedocs.io/en/latest/contributing/) for details.

unitysvc_services-0.1.24.dist-info/RECORD

@@ -0,0 +1,37 @@
+unitysvc_services/__init__.py,sha256=J6F3RlZCJUVjhZoprfbrYCxe3l9ynQQbGO7pf7FyqlM,110
+unitysvc_services/api.py,sha256=PuejbQg6PLKPmHbWNhCmLLjFJXfLMS369-M44m-u6w4,15989
+unitysvc_services/cli.py,sha256=ISJxjWqQ8O5cyhamEDdt-b4hHYCFp0Pf-o3vT60g7js,787
+unitysvc_services/format_data.py,sha256=Jl9Vj3fRX852fHSUa5DzO-oiFQwuQHC3WMCDNIlo1Lc,5460
+unitysvc_services/interactive_prompt.py,sha256=IlKvtYlLziP_SA_b6BdKPAS3QLAH-ZnSmt-zjQcfuVY,39593
+unitysvc_services/list.py,sha256=QDp9BByaoeFeJxXJN9RQ-jU99mH9Guq9ampfXCbpZmI,7033
+unitysvc_services/populate.py,sha256=lAbu-EMbvM3qk9P_MQ0sQc74IyZigcj-u3eUcgi9Qpw,8063
+unitysvc_services/publisher.py,sha256=AgvoEv6Kca2Dq61ZazZRq1NQcTu1VPpUXEIpMjs_z24,68233
+unitysvc_services/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+unitysvc_services/query.py,sha256=-aiUYmgmeKUhT9stjpAZS_mzpmylk7FB4b-NqMM4n0Y,24132
+unitysvc_services/scaffold.py,sha256=jPTtC7i0Uw61Z4uE51OrWQBW2eGlmyFEhvcC3csKyxc,43321
+unitysvc_services/test.py,sha256=LCZaAW1GCmYSTDKsTamTcNaeRZdCeiO0csqmmJ4uRQo,37646
+unitysvc_services/unpublisher.py,sha256=EkUGHdG8VK9qCyIhrqy4yRzk_NH-gTYhyd_xHTfS05Y,16640
+unitysvc_services/update.py,sha256=hkQlEk6sUpVGnySnrTqI6jcGphbLUEf8_KmY-f63p8M,9604
+unitysvc_services/utils.py,sha256=PCRmbk9efJajWGMeL1CFC5jk-HJJbGe5roSZcLu0XSI,18501
+unitysvc_services/validator.py,sha256=pICY5NwDS9rrLMeZAl23c2JHqzq5aIwRsMTU3kMDNBg,30525
+unitysvc_services/models/__init__.py,sha256=iAHGfKKTMNQsQieLPh2v5x8xTicGh_5GwxPzbVTZSVk,1630
+unitysvc_services/models/base.py,sha256=4Ll1JH9jdu0MYBJN2al7VMgEmfKDzav_9ioZJnd901M,47038
+unitysvc_services/models/listing_data.py,sha256=SBpsdV5uvHSe6xqbZIZvT_iQG5TeM7uxguTUG7q5n_c,4090
+unitysvc_services/models/listing_v1.py,sha256=d3zBoTw0-E5NqMSRLw5FfsYrieDFvr8azOL3cI4v9XM,1951
+unitysvc_services/models/provider_data.py,sha256=s3OJrwp2lVJXeGXCpHuuiuTLD-pLRxVf_c9UFTKMgqI,2598
+unitysvc_services/models/provider_v1.py,sha256=yKhqiN2zi9S2Vwo3dO4Qeh0U630bKtV2mhwcxQQw12Q,2088
+unitysvc_services/models/seller_data.py,sha256=f1igTxG1EOPwZWtKR3TXr77oKYgA44WGs13GM0EZvik,3715
+unitysvc_services/models/seller_v1.py,sha256=CeQiG7sumqLG1Mhhw7v6Gt_Vhk2FeHWCnA2LaBMgJ5I,1519
+unitysvc_services/models/service_data.py,sha256=j6hlOBGVuwP16jHwsXmjqtR2NC5eYe-pBMvkC5eymB0,3552
+unitysvc_services/models/service_v1.py,sha256=12njtp8CB1eZ-jXwJLlAjNlOBzFYfAuqPzR9IMa3pKQ,2757
+unitysvc_services/schema/base.json,sha256=toIx658GINXrQgUciGNLvXBcnfXsFUO9zl1UUqROXMA,18289
+unitysvc_services/schema/listing_v1.json,sha256=bkFJiKZJiZxxVtActgGfeekS2DCefsCzSIxgEN_SLys,33374
+unitysvc_services/schema/provider_v1.json,sha256=xz0Nc-G6e3cC-NhJS8OMoTZbqjePPHMW2PRfHOpCclM,23320
+unitysvc_services/schema/seller_v1.json,sha256=B7BWcefqAulkxmUn5I_66oFSjSUDv2sZ-gWoSMgqg8E,9178
+unitysvc_services/schema/service_v1.json,sha256=GQ5bTOdjeHOJROzpexfFmpqIlj6yYRy4V8G-_AbzJ5E,33298
+unitysvc_services-0.1.24.dist-info/licenses/LICENSE,sha256=_p8V6A8OMPu2HIztn3O01v0-urZFwk0Dd3Yk_PTIlL8,1065
+unitysvc_services-0.1.24.dist-info/METADATA,sha256=Tr1T0xLecL5wkUqoo1jK8Dg0ropFq07CD7tCRGrBwz8,7413
+unitysvc_services-0.1.24.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+unitysvc_services-0.1.24.dist-info/entry_points.txt,sha256=RBhVHKky3rsOly4jVa29c7UAw5ZwNNWnttmtzozr5O0,97
+unitysvc_services-0.1.24.dist-info/top_level.txt,sha256=GIotQj-Ro2ruR7eupM1r58PWqIHTAq647ORL7E2kneo,18
+unitysvc_services-0.1.24.dist-info/RECORD,,

unitysvc_services-0.1.24.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

unitysvc_services-0.1.24.dist-info/entry_points.txt

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

unitysvc_services-0.1.24.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025, Bo Peng
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

unitysvc_services-0.1.24.dist-info/top_level.txt

@@ -0,0 +1 @@
+unitysvc_services