harness-platform-sdk 1.0.0__tar.gz

harness_platform_sdk-1.0.0/PKG-INFO

@@ -0,0 +1,209 @@
+Metadata-Version: 2.4
+Name: harness-platform-sdk
+Version: 1.0.0
+Summary: Python SDK for the Harness Platform API
+Author-email: Harness <platform@harness.io>
+License-Expression: BUSL-1.1
+Project-URL: Homepage, https://github.com/harness/harness-platform-sdk
+Project-URL: Repository, https://github.com/harness/harness-platform-sdk
+Project-URL: Issues, https://github.com/harness/harness-platform-sdk/issues
+Project-URL: Changelog, https://github.com/harness/harness-platform-sdk/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://developer.harness.io/harness-solutions-factory/use-hsf/plugins/harness-platform-sdk
+Project-URL: AI-Agent Docs, https://developer.harness.io/harness-solutions-factory/use-hsf/plugins/harness-platform-sdk/llms.md
+Keywords: harness,api,sdk,iac
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: httpx>=0.25.0
+Requires-Dist: pydantic>=2.0
+Requires-Dist: tenacity>=8.2.0
+Requires-Dist: PyYAML==6.0.3
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4.0; extra == "dev"
+Requires-Dist: pytest-httpx>=0.21.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
+Requires-Dist: Jinja2==3.1.6; extra == "dev"
+Requires-Dist: pdoc3==0.11.6; extra == "dev"
+Requires-Dist: black==26.5.1; extra == "dev"
+Requires-Dist: isort==8.0.1; extra == "dev"
+Requires-Dist: mypy==1.20.2; extra == "dev"
+Requires-Dist: ruff>=0.16; extra == "dev"
+Provides-Extra: publish
+Requires-Dist: build>=1.0.0; extra == "publish"
+Requires-Dist: twine>=5.0.0; extra == "publish"
+Requires-Dist: wheel>=0.41.0; extra == "publish"
+
+# Harness Platform SDK
+
+A production-grade Python SDK for the Harness platform API. Built with Pydantic v2, httpx, and comprehensive test coverage.
+
+## Quick Start
+
+```python
+from harness_platform_sdk import HarnessClient
+
+# Create a client
+client = HarnessClient(
+    api_key="your-api-key",
+    account_id="your-account-id",
+    default_org="your-org",
+    default_project="your-project"
+)
+
+# Use context manager for automatic cleanup
+with client:
+    # Access resource APIs
+    orgs = client.organizations.list()
+    for org in orgs:
+        print(f"Organization: {org.identifier}")
+```
+
+## Installation
+
+```bash
+pip install harness-platform-sdk
+```
+
+## Architecture
+
+### Core Modules
+
+- **`HarnessClient`** — Main entry point for all API interactions
+  - HTTP methods with built-in retry (429, 503)
+  - Scope resolution (account/org/project)
+  - URL template substitution
+  - Pagination support (OFFSET and CURSOR styles)
+
+- **`HarnessConfig`** — Configuration management
+  - API key, account ID, base URL
+  - Timeout, retry settings
+  - SSL verification control
+
+- **`Scope`** — Request context model
+  - Frozen Pydantic model
+  - Account ID (required), org/project (optional)
+
+- **Exception Hierarchy**
+  - `HarnessSdkError` — Base exception
+  - `ScopeNotSetError` — Missing required scope fields
+  - `ApiError` — Non-2xx responses (with status, body, headers)
+  - `AuthError` — 401/403 responses
+
+- **`PaginationStyle`** — Pagination type enum
+  - `OFFSET` — pageIndex/pageSize pagination
+  - `CURSOR` — nextPageToken pagination
+
+### Resource APIs
+
+The SDK includes typed API wrappers for Harness platform resources across multiple domains:
+
+- **Next-Gen (Core):** Organizations, Projects, Services, Service Overrides, Connectors, Secrets, Infrastructures, Variables, User Groups, Environments V2
+- **Pipeline:** Pipelines (v0), Input Sets (v0), Triggers (v0), Templates (v0)
+- **Authorization:** Roles, Resource Groups, Role Assignments
+- **Infrastructure as Code:** Workspaces, Workspace Approvals, Workspace States, Workspace Variables, Workspace Default Pipelines
+- **Internal Developer Portal:** Entities, Catalog Custom Properties, Scores
+
+### Design Principles
+
+1. **Single Entry Point** — All domain APIs are accessed via `HarnessClient`
+2. **Scope Resolution** — Client automatically merges call-time and default scopes
+3. **Type Safety** — Full Pydantic v2 models with validation
+4. **Error Handling** — Explicit exception types with actionable messages
+5. **Retry Logic** — Automatic retry on transient failures with exponential backoff
+6. **No Async** — Pure sync using httpx (async support deferred to future version)
+
+## Configuration
+
+```python
+from harness_platform_sdk import HarnessClient, HarnessConfig
+
+# Option 1: Keyword arguments
+client = HarnessClient(
+    api_key="key",
+    account_id="acc",
+    default_org="my-org"
+)
+
+# Option 2: Explicit config
+config = HarnessConfig(
+    api_key="key",
+    account_id="acc",
+    base_url="https://app.harness.io",
+    timeout=30.0,
+    max_retries=3,
+    retry_status_codes=[429, 503],
+    retry_enabled=True,
+    verify_ssl=True
+)
+client = HarnessClient(config=config)
+```
+
+## Error Handling
+
+```python
+from harness_platform_sdk import HarnessClient, AuthError, ApiError
+
+client = HarnessClient(api_key="key", account_id="acc")
+
+try:
+    result = client._get("/some/endpoint")
+except AuthError as e:
+    print(f"Auth failed: {e.status_code}")
+    # Handle 401/403
+except ApiError as e:
+    print(f"API error: {e.status_code}")
+    # Handle other non-2xx
+finally:
+    client.close()
+```
+
+## Scope Management
+
+```python
+from harness_platform_sdk import HarnessClient, Scope
+
+# Set default scope at construction
+client = HarnessClient(
+    api_key="key",
+    account_id="acc",
+    default_org="org-1",
+    default_project="proj-1"
+)
+
+# Update default scope
+client.set_default_scope(org="org-2", project="proj-2")
+
+# Override scope for a specific call (future: when domain APIs are added)
+# resource_manager.get(resource_id, scope=Scope(account_id="acc", org="org-temp"))
+```
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development guidelines.
+
+## Testing
+
+```bash
+# Run all tests
+mise run tests
+
+# Run with coverage report
+mise run tests:cov
+
+# Run specific test file
+pytest tests/unit_tests/test_client.py -v
+```
+
+## Version
+
+- **Current:** 1.0.0
+- **Stability:** Production-ready (v1.0.0 release)
+
+## License
+
+Business Source License 1.1 (BUSL-1.1) — See [License](License) for details.

harness_platform_sdk-1.0.0/README.md

@@ -0,0 +1,169 @@
+# Harness Platform SDK
+
+A production-grade Python SDK for the Harness platform API. Built with Pydantic v2, httpx, and comprehensive test coverage.
+
+## Quick Start
+
+```python
+from harness_platform_sdk import HarnessClient
+
+# Create a client
+client = HarnessClient(
+    api_key="your-api-key",
+    account_id="your-account-id",
+    default_org="your-org",
+    default_project="your-project"
+)
+
+# Use context manager for automatic cleanup
+with client:
+    # Access resource APIs
+    orgs = client.organizations.list()
+    for org in orgs:
+        print(f"Organization: {org.identifier}")
+```
+
+## Installation
+
+```bash
+pip install harness-platform-sdk
+```
+
+## Architecture
+
+### Core Modules
+
+- **`HarnessClient`** — Main entry point for all API interactions
+  - HTTP methods with built-in retry (429, 503)
+  - Scope resolution (account/org/project)
+  - URL template substitution
+  - Pagination support (OFFSET and CURSOR styles)
+
+- **`HarnessConfig`** — Configuration management
+  - API key, account ID, base URL
+  - Timeout, retry settings
+  - SSL verification control
+
+- **`Scope`** — Request context model
+  - Frozen Pydantic model
+  - Account ID (required), org/project (optional)
+
+- **Exception Hierarchy**
+  - `HarnessSdkError` — Base exception
+  - `ScopeNotSetError` — Missing required scope fields
+  - `ApiError` — Non-2xx responses (with status, body, headers)
+  - `AuthError` — 401/403 responses
+
+- **`PaginationStyle`** — Pagination type enum
+  - `OFFSET` — pageIndex/pageSize pagination
+  - `CURSOR` — nextPageToken pagination
+
+### Resource APIs
+
+The SDK includes typed API wrappers for Harness platform resources across multiple domains:
+
+- **Next-Gen (Core):** Organizations, Projects, Services, Service Overrides, Connectors, Secrets, Infrastructures, Variables, User Groups, Environments V2
+- **Pipeline:** Pipelines (v0), Input Sets (v0), Triggers (v0), Templates (v0)
+- **Authorization:** Roles, Resource Groups, Role Assignments
+- **Infrastructure as Code:** Workspaces, Workspace Approvals, Workspace States, Workspace Variables, Workspace Default Pipelines
+- **Internal Developer Portal:** Entities, Catalog Custom Properties, Scores
+
+### Design Principles
+
+1. **Single Entry Point** — All domain APIs are accessed via `HarnessClient`
+2. **Scope Resolution** — Client automatically merges call-time and default scopes
+3. **Type Safety** — Full Pydantic v2 models with validation
+4. **Error Handling** — Explicit exception types with actionable messages
+5. **Retry Logic** — Automatic retry on transient failures with exponential backoff
+6. **No Async** — Pure sync using httpx (async support deferred to future version)
+
+## Configuration
+
+```python
+from harness_platform_sdk import HarnessClient, HarnessConfig
+
+# Option 1: Keyword arguments
+client = HarnessClient(
+    api_key="key",
+    account_id="acc",
+    default_org="my-org"
+)
+
+# Option 2: Explicit config
+config = HarnessConfig(
+    api_key="key",
+    account_id="acc",
+    base_url="https://app.harness.io",
+    timeout=30.0,
+    max_retries=3,
+    retry_status_codes=[429, 503],
+    retry_enabled=True,
+    verify_ssl=True
+)
+client = HarnessClient(config=config)
+```
+
+## Error Handling
+
+```python
+from harness_platform_sdk import HarnessClient, AuthError, ApiError
+
+client = HarnessClient(api_key="key", account_id="acc")
+
+try:
+    result = client._get("/some/endpoint")
+except AuthError as e:
+    print(f"Auth failed: {e.status_code}")
+    # Handle 401/403
+except ApiError as e:
+    print(f"API error: {e.status_code}")
+    # Handle other non-2xx
+finally:
+    client.close()
+```
+
+## Scope Management
+
+```python
+from harness_platform_sdk import HarnessClient, Scope
+
+# Set default scope at construction
+client = HarnessClient(
+    api_key="key",
+    account_id="acc",
+    default_org="org-1",
+    default_project="proj-1"
+)
+
+# Update default scope
+client.set_default_scope(org="org-2", project="proj-2")
+
+# Override scope for a specific call (future: when domain APIs are added)
+# resource_manager.get(resource_id, scope=Scope(account_id="acc", org="org-temp"))
+```
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development guidelines.
+
+## Testing
+
+```bash
+# Run all tests
+mise run tests
+
+# Run with coverage report
+mise run tests:cov
+
+# Run specific test file
+pytest tests/unit_tests/test_client.py -v
+```
+
+## Version
+
+- **Current:** 1.0.0
+- **Stability:** Production-ready (v1.0.0 release)
+
+## License
+
+Business Source License 1.1 (BUSL-1.1) — See [License](License) for details.

harness_platform_sdk-1.0.0/pyproject.toml

@@ -0,0 +1,142 @@
+[build-system]
+requires = ["setuptools>=68.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "harness-platform-sdk"
+version = "1.0.0"
+description = "Python SDK for the Harness Platform API"
+readme = "README.md"
+requires-python = ">=3.11"
+license = "BUSL-1.1"
+authors = [
+    {name = "Harness", email = "platform@harness.io"}
+]
+keywords = ["harness", "api", "sdk", "iac"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Operating System :: OS Independent",
+]
+
+dependencies = [
+    "httpx>=0.25.0",
+    "pydantic>=2.0",
+    "tenacity>=8.2.0",
+    "PyYAML==6.0.3",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.4.0",
+    "pytest-httpx>=0.21.0",
+    "pytest-cov>=4.1.0",
+    "Jinja2==3.1.6",
+    "pdoc3==0.11.6",
+    "black==26.5.1",
+    "isort==8.0.1",
+    "mypy==1.20.2",
+    "ruff>=0.16",
+]
+publish = [
+    "build>=1.0.0",
+    "twine>=5.0.0",
+    "wheel>=0.41.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/harness/harness-platform-sdk"
+Repository = "https://github.com/harness/harness-platform-sdk"
+Issues = "https://github.com/harness/harness-platform-sdk/issues"
+Changelog = "https://github.com/harness/harness-platform-sdk/blob/main/CHANGELOG.md"
+Documentation = "https://developer.harness.io/harness-solutions-factory/use-hsf/plugins/harness-platform-sdk"
+"AI-Agent Docs" = "https://developer.harness.io/harness-solutions-factory/use-hsf/plugins/harness-platform-sdk/llms.md"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+harness_platform_sdk = ["py.typed"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = "test_*.py"
+python_classes = "Test*"
+python_functions = "test_*"
+addopts = "-v --strict-markers"
+markers = [
+    "unit: unit tests",
+    "integration: integration tests",
+    "regression: regression tests",
+]
+doctest_optionflags = "NORMALIZE_WHITESPACE ELLIPSIS"
+
+[tool.coverage.run]
+source = ["src/harness_platform_sdk"]
+omit = [
+    "src/harness_platform_sdk/models/*",
+    "*/tests/*",
+]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if __name__ == .__main__.:",
+    "if TYPE_CHECKING:",
+    "^\\s*@abstractmethod",
+]
+fail_under = 85
+precision = 2
+
+[tool.black]
+line-length = 100
+target-version = ["py311"]
+
+[tool.isort]
+profile = "black"
+line_length = 100
+py_version = 311
+
+[tool.mypy]
+python_version = "3.11"
+warn_return_any = false
+warn_unused_configs = true
+disallow_untyped_defs = false
+ignore_missing_imports = true
+check_untyped_defs = false
+warn_incomplete_stub = false
+
+# Suppress type checking for model files due to Pydantic field integration complexity
+# and for API managers that work with polymorphic request/response models
+[[tool.mypy.overrides]]
+module = [
+    "harness_platform_sdk.models.*",
+    "harness_platform_sdk.client",
+    "harness_platform_sdk.ng_api.*",
+    "harness_platform_sdk.authz.*",
+    "harness_platform_sdk.pipeline_api.*",
+    "harness_platform_sdk.template_api.*",
+    "harness_platform_sdk.iacm_api.*",
+    "harness_platform_sdk.idp_api.*",
+]
+ignore_errors = true
+
+[tool.ruff]
+line-length = 100
+
+[tool.ruff.lint]
+select = [
+    "D100", "D101", "D102", "D103", "D104", "D105", "D107",  # pydocstyle docstring rules
+]
+ignore = [
+    "D105",  # Magic method docstring requirement (too strict for common methods)
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"

harness_platform_sdk-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

harness_platform_sdk-1.0.0/src/harness_platform_sdk/__init__.py

@@ -0,0 +1,56 @@
+"""Harness Platform SDK.
+
+A Python SDK for interacting with the Harness Platform API.
+Provides unified access to all Harness APIs (Organizations, Projects,
+Pipelines, Connectors, Secrets, and more) with built-in authentication,
+scope management, pagination, and retry handling.
+"""
+
+from .authz import *
+from .client import HarnessClient
+from .config import HarnessConfig
+from .exceptions import ApiError, AuthError, HarnessSdkError, ScopeNotSetError
+from .iacm_api import *
+from .idp_api import *
+from .ng_api import *
+from .pipeline_api import *
+from .scope import Scope
+from .template_api import *
+
+__version__ = "1.0.0"
+
+__all__ = [
+    "HarnessClient",
+    "HarnessConfig",
+    "Scope",
+    "HarnessSdkError",
+    "ScopeNotSetError",
+    "ApiError",
+    "AuthError",
+    "OrganizationsApi",
+    "ProjectsApi",
+    "ServicesApi",
+    "RolesApi",
+    "ResourceGroupsApi",
+    "RoleAssignmentsApi",
+    "ConnectorsApi",
+    "SecretsApi",
+    "InfrastructuresApi",
+    "UserGroupsApi",
+    "PipelinesV0Api",
+    "InputSetsV0Api",
+    "TriggersV0Api",
+    "TemplatesV0Api",
+    "VariablesApi",
+    "ServiceOverridesApi",
+    # Infrastructure as Code
+    "WorkspacesApi",
+    "WorkspaceApprovalsApi",
+    "WorkspaceDefaultPipelinesApi",
+    "WorkspaceStatesApi",
+    "WorkspaceVariablesApi",
+    # Internal Developer Portal
+    "CatalogCustomPropertyApi",
+    "EntityApi",
+    "ScoreApi",
+]

harness_platform_sdk-1.0.0/src/harness_platform_sdk/authz/__init__.py

@@ -0,0 +1,15 @@
+"""Harness Authorization API resources.
+
+Provides APIs for managing roles, resource groups, and role assignments
+under the /authz/ path root.
+"""
+
+from .resource_groups import ResourceGroupsApi
+from .role_assignments import RoleAssignmentsApi
+from .roles import RolesApi
+
+__all__ = [
+    "RolesApi",
+    "ResourceGroupsApi",
+    "RoleAssignmentsApi",
+]