unitysvc-services 0.1.29

SDK for digital service providers on UnitySVC

UnitySVC Services SDK

Client library and CLI tools for sellers and providers of digital service to interact with the UnitySVC platform.

📚 Full Documentation | 🚀 Getting Started | 📖 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

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

# Initialize provider and service (using short alias 'usvc')
usvc init provider my-provider
usvc init offering my-offering
usvc init service my-listing

# 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)

init → edit files → validate → test → format → publish → verify

Automated Workflow (large/dynamic catalogs)

init → configure populate script → populate → validate → publish

See Workflows Documentation for details.

Data Structure

data/
├── ${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 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 for complete documentation.

Documentation

• Getting Started - Installation and first steps
• Data Structure - File organization rules
• Workflows - Manual and automated patterns
• Documenting Service Listings - Add documentation to services
• Creating Code Examples - Develop and test code examples
• CLI Reference - All commands and options
• File Schemas - Schema specifications
• Python API - 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 file for details.

Contributing

Contributions welcome! See Contributing Guide for details.