Skip to main content

Python SDK for building jobs on the Terse platform.

Project description

terse-sdk

Python SDK for building jobs on the Terse platform.

Most users should start with terse-cli, which scaffolds a project and generates terse_generated.py helpers for the currently supported trigger and skill surface.

Installation

python -m pip install terse-sdk

Runtime API

The SDK provides:

  • Terse for runtime job registration
  • @app.job(...) for declaring jobs
  • TerseAgent for agent runs and deterministic tool execution
  • typed event models such as CronJobInputEvent
  • hand-written request/response models exported from terse_sdk

Quick Start

from terse_sdk import CronJobInputEvent, Terse
from terse_sdk.types.stream_events import SdkAgentStreamEventFinalOutput
from terse_generated import Schedule, TerseAgent

app = Terse()

@app.job(
    name="example-job",
    triggers=[Schedule.cron("0 9 * * 1")],
    skills=[],
)
def run_job(event: CronJobInputEvent, agent: TerseAgent) -> None:
    prompt = (
        "Answer with one short, cute sentence about this cron job. "
        f"Context: {event.formatted_content}"
    )
    for stream_event in agent.run(prompt, event):
        if isinstance(stream_event, SdkAgentStreamEventFinalOutput):
            print(stream_event.finalOutput)

Trigger and skill configs come from the generated helpers in terse_generated.py. Run terse init and terse generate to scaffold a project.

Generated Helpers

The SDK package does not generate project helpers by itself.

If you scaffold a project with terse init and then run terse generate, your project gets src/terse_generated.py with the currently supported helpers:

  • Schedule.cron(...)
  • Attio.skill(...)
  • Snowflake.skill(...)
  • deterministic wrappers on agent.tools.attio and agent.tools.snowflake

Example inside a generated project:

from terse_generated import Schedule, Snowflake, TerseAgent
from terse_sdk import CronJobInputEvent, Terse

app = Terse()

@app.job(
    name="snowflake-job",
    triggers=[Schedule.cron("0 9 * * 1")],
    skills=[Snowflake.skill()],
)
def example(event: CronJobInputEvent, agent: TerseAgent) -> None:
    result = agent.tools.snowflake.execute_query(query="select current_date()")
    print(result)

Environment Variables

  • TERSE_API_KEY: required for agent runs and deterministic tool execution

Recommended Path

If you want the full project workflow, install the CLI instead:

python -m pip install terse-cli
terse init my-terse-job

Source

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

terse_sdk-0.1.4.tar.gz (16.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

terse_sdk-0.1.4-py3-none-any.whl (21.0 kB view details)

Uploaded Python 3

File details

Details for the file terse_sdk-0.1.4.tar.gz.

File metadata

  • Download URL: terse_sdk-0.1.4.tar.gz
  • Upload date:
  • Size: 16.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for terse_sdk-0.1.4.tar.gz
Algorithm Hash digest
SHA256 f7201b1dfdb4e03ebb0a090042d96ec09b820702258fa28cdb888394e39e325d
MD5 68a0ea3222610a8480bd1729420d5386
BLAKE2b-256 ede6f7ad41e4eff172ebe5c978421c056762f4f3e65bb8f11b36804bb52fc2e4

See more details on using hashes here.

File details

Details for the file terse_sdk-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: terse_sdk-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 21.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for terse_sdk-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 f1ef5369df57c24a7b5a5c3728d8fe2329e6d064bc20d06bcbf289ffe2062fc8
MD5 a0bc4eb8e14884c2148bd892acf64e17
BLAKE2b-256 74b616cf67d28e439275c82c16cf829369488d1f6b273db3d9e803be34b6626b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page