kotharcomputing 0.106.0__tar.gz → 1.0.1__tar.gz

kotharcomputing-1.0.1/PKG-INFO

@@ -0,0 +1,74 @@
+Metadata-Version: 2.4
+Name: kotharcomputing
+Version: 1.0.1
+Summary: Python SDK for the Kothar API
+Author: Kothar Computing
+License-Expression: Apache-2.0
+Keywords: kothar,api,sdk
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# Kothar Python SDK
+
+Python SDK for the Kothar API generated from `schemas/openapi.yml`.
+
+Install the published SDK with `pip install kotharcomputing`. Starting with `1.0.0`,
+the package is released from `kothardev/kothar-platform` and its version follows the
+platform tag (`v1.0.0` publishes `1.0.0`). It replaces the package previously built
+in `kothar-backend`; use the workspace and target API examples below when updating
+applications from the legacy SDK. Existing PyPI releases remain available for pinned installations.
+
+## Aleph language server
+
+The SDK also provides a separate anonymous HTTP client for the Aleph language
+server. It does not use Kothar API authentication:
+
+```python
+from kotharcomputing import AlephLanguageServerClient
+
+aleph = AlephLanguageServerClient()
+analysis = aleph.analyze('print("hello")', include_ast=True)
+parsed = aleph.ast('print("hello")', format=True, discover_test=True)
+tests = aleph.discover_tests('test "example" {}')
+formatted = aleph.format('print( "hello" )')
+```
+
+Pass `base_url=` or `AlephLanguageServerClientOptions` to use another Aleph
+deployment. The default endpoint is `https://aleph.kotharcomputing.com`.
+
+`ast` accepts an optional structured `filter` and returns a required AST with syntax and light binding diagnostics,
+without establishing full type correctness. Both `ast` and `analyze` accept `format` and `discover_test`; their optional
+`tests` field and the direct `discover_tests` result use `AlephTestDiscoverySection`, with recursive sections and typed
+test metadata. Discovery does not execute source or tests. The client-level `timeout` applies to these methods too.
+
+The reviewed contract is pinned in `schemas/aleph-openapi.json`; maintenance and SDK parity checks are documented in
+[RFC 0013](../../../docs/rfcs/0013-workshop-tasks-and-aleph-execution.md).
+
+## Workshop API tokens
+
+Create an immutable token in **Account settings → API tokens**, explicitly select its permissions, and save the
+credential when it is shown. Delete it to revoke access; create a replacement to change metadata, expiration, or grants.
+Non-expiring tokens keep their issued grants until revoked.
+
+This example needs **Files → List (All files)** and **Targets → List**. Set the credential and the workspace/user IDs shown
+on the account page in environment variables. API tokens cannot use the session-only `personal` or `me` aliases. Never
+save credentials in source code, logs, or browser storage.
+
+```python
+import os
+from kotharcomputing import KotharClient
+
+client = KotharClient(access_token=os.environ["KOTHAR_API_TOKEN"])
+files = client.workspaces.id(os.environ["KOTHAR_WORKSPACE_ID"]).files.list()
+targets = client.users.id(os.environ["KOTHAR_USER_ID"]).targets.list()
+```
+
+Creating tasks also needs read access to the chosen task definition and any specified target. Task search-schema
+discovery needs **Targets → List** and **Task definitions → List**. Add these grants explicitly when needed.

kotharcomputing-1.0.1/README.md

@@ -0,0 +1,57 @@
+# Kothar Python SDK
+
+Python SDK for the Kothar API generated from `schemas/openapi.yml`.
+
+Install the published SDK with `pip install kotharcomputing`. Starting with `1.0.0`,
+the package is released from `kothardev/kothar-platform` and its version follows the
+platform tag (`v1.0.0` publishes `1.0.0`). It replaces the package previously built
+in `kothar-backend`; use the workspace and target API examples below when updating
+applications from the legacy SDK. Existing PyPI releases remain available for pinned installations.
+
+## Aleph language server
+
+The SDK also provides a separate anonymous HTTP client for the Aleph language
+server. It does not use Kothar API authentication:
+
+```python
+from kotharcomputing import AlephLanguageServerClient
+
+aleph = AlephLanguageServerClient()
+analysis = aleph.analyze('print("hello")', include_ast=True)
+parsed = aleph.ast('print("hello")', format=True, discover_test=True)
+tests = aleph.discover_tests('test "example" {}')
+formatted = aleph.format('print( "hello" )')
+```
+
+Pass `base_url=` or `AlephLanguageServerClientOptions` to use another Aleph
+deployment. The default endpoint is `https://aleph.kotharcomputing.com`.
+
+`ast` accepts an optional structured `filter` and returns a required AST with syntax and light binding diagnostics,
+without establishing full type correctness. Both `ast` and `analyze` accept `format` and `discover_test`; their optional
+`tests` field and the direct `discover_tests` result use `AlephTestDiscoverySection`, with recursive sections and typed
+test metadata. Discovery does not execute source or tests. The client-level `timeout` applies to these methods too.
+
+The reviewed contract is pinned in `schemas/aleph-openapi.json`; maintenance and SDK parity checks are documented in
+[RFC 0013](../../../docs/rfcs/0013-workshop-tasks-and-aleph-execution.md).
+
+## Workshop API tokens
+
+Create an immutable token in **Account settings → API tokens**, explicitly select its permissions, and save the
+credential when it is shown. Delete it to revoke access; create a replacement to change metadata, expiration, or grants.
+Non-expiring tokens keep their issued grants until revoked.
+
+This example needs **Files → List (All files)** and **Targets → List**. Set the credential and the workspace/user IDs shown
+on the account page in environment variables. API tokens cannot use the session-only `personal` or `me` aliases. Never
+save credentials in source code, logs, or browser storage.
+
+```python
+import os
+from kotharcomputing import KotharClient
+
+client = KotharClient(access_token=os.environ["KOTHAR_API_TOKEN"])
+files = client.workspaces.id(os.environ["KOTHAR_WORKSPACE_ID"]).files.list()
+targets = client.users.id(os.environ["KOTHAR_USER_ID"]).targets.list()
+```
+
+Creating tasks also needs read access to the chosen task definition and any specified target. Task search-schema
+discovery needs **Targets → List** and **Task definitions → List**. Add these grants explicitly when needed.

{kotharcomputing-0.106.0 → kotharcomputing-1.0.1}/pyproject.toml

@@ -1,24 +1,24 @@
 [build-system]
-requires = ["setuptools>=82.0.1", "wheel>=0.47.0"]
+requires = ["setuptools>=84.0.0", "wheel>=0.48.0"]
 build-backend = "setuptools.build_meta"
 
 [project]
 name = "kotharcomputing"
-version = "0.106.0"
+version = "1.0.1"
 description = "Python SDK for the Kothar API"
 readme = "README.md"
 requires-python = ">=3.11"
 license = "Apache-2.0"
-license-files = ["LICENSE"]
 authors = [{ name = "Kothar Computing" }]
 dependencies = []
-optional-dependencies = { dev = ["poethepoet>=0.46.0", "ruff>=0.15.14", "pytest>=9.0.3", "build>=1.5.0"] }
 keywords = ["kothar", "api", "sdk"]
 classifiers = [
   "Programming Language :: Python :: 3",
   "Programming Language :: Python :: 3 :: Only",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
   "Typing :: Typed",
 ]
 
@@ -30,18 +30,3 @@ where = ["src"]
 
 [tool.setuptools.package-data]
 kotharcomputing = ["py.typed"]
-
-[tool.ruff.lint]
-select = ["E4", "E7", "E9", "F"]
-
-[tool.poe.tasks]
-format = "ruff format src"
-format-check = "ruff format --check src"
-lint = "ruff check src"
-lint-fix = "ruff check --fix src"
-test = "pytest -q"
-build = "python scripts/build_package.py"
-
-[tool.poe.tasks.check]
-help = "Run formatting, linting and tests"
-sequence = ["format-check", "lint", "test"]

kotharcomputing-1.0.1/src/kotharcomputing/__init__.py

@@ -0,0 +1,54 @@
+from ._generated import types as _types
+from ._generated.types import *  # noqa: F403
+from .aleph_language_server import (
+    DEFAULT_ALEPH_LANGUAGE_SERVER_BASE_URL,
+    AlephAnalyzeResult,
+    AlephAstFilter,
+    AlephAstFilterClause,
+    AlephAstLocation,
+    AlephAstNode,
+    AlephAstNodeType,
+    AlephAstResult,
+    AlephAstTextFilter,
+    AlephDiagnostic,
+    AlephDiagnosticSeverity,
+    AlephLanguageServerClient,
+    AlephLanguageServerClientOptions,
+    AlephPosition,
+    AlephRange,
+    AlephTestDiscoveryLocation,
+    AlephTestDiscoverySection,
+    AlephTestDiscoveryTest,
+)
+from .client import DEFAULT_BASE_URL, KotharClient, KotharClientOptions
+from .errors import KOTHAR_ERROR_TYPE_BASE_URL, KotharApiError, ProblemDetails
+from .transport import ApiTransport, RawResponse
+
+__all__ = [
+    "AlephAnalyzeResult",
+    "AlephAstFilter",
+    "AlephAstFilterClause",
+    "AlephAstLocation",
+    "AlephAstNode",
+    "AlephAstNodeType",
+    "AlephAstResult",
+    "AlephAstTextFilter",
+    "AlephDiagnostic",
+    "AlephDiagnosticSeverity",
+    "AlephLanguageServerClient",
+    "AlephLanguageServerClientOptions",
+    "AlephPosition",
+    "AlephRange",
+    "AlephTestDiscoveryLocation",
+    "AlephTestDiscoverySection",
+    "AlephTestDiscoveryTest",
+    "ApiTransport",
+    "DEFAULT_BASE_URL",
+    "DEFAULT_ALEPH_LANGUAGE_SERVER_BASE_URL",
+    "KOTHAR_ERROR_TYPE_BASE_URL",
+    "KotharApiError",
+    "KotharClient",
+    "KotharClientOptions",
+    "ProblemDetails",
+    "RawResponse",
+] + [name for name in dir(_types) if not name.startswith("_")]

kotharcomputing-1.0.1/src/kotharcomputing/_generated/__init__.py

@@ -0,0 +1 @@
+"""Generated OpenAPI types and operation helpers."""