Skip to main content

CLI and Python API for running Talend Cloud jobs

Project description

talend-task

CLI and Python API for running Talend Cloud jobs


Status

Latest Version
Build (CI)
Supported Python Versions

About

The talend-task package provides a command-line interface and Python API client for executing and monitoring jobs in Talend Cloud, including ETL pipelines and other data workflows. It uses the Processing API to trigger executions and monitor their status.

The package consists of:

  • command-line interface (talend_task)
  • Python API client module (talend_task.talend_client) providing the TalendClient class

In this package, a “job” refers to a runnable Talend Task. Running a job creates a corresponding Talend Execution.


Installation

Install the package from PyPI:

pip install talend-task

CLI

talend_task is a CLI for running and monitoring jobs in Talend Cloud.

After installation, the talend_task command is available in your shell.

Select a job interactively or pass --job directly.

CLI Options:

$ talend_task --help
usage: talend_task [-h] [--debug] [--wait] [--activity] [--job NAME] [--timeout SECS]
                   [--poll-interval SECS]

Talend Cloud CLI

options:
  -h, --help            show this help message and exit
  --debug               enable debug logging
  --wait                wait for job to complete and return status
  --activity            show recent runs without executing job (cannot use --wait)
  --job NAME            job name
  --timeout SECS        timeout (requires --wait, default: none)
  --poll-interval SECS  polling interval (requires --wait, default: 5)

CLI Configuration

The CLI requires an Access Token and an API URL for your Talend Cloud region.

Configuration is provided via environment variables:

export API_URL=https://api.<region>.cloud.talend.com
export ACCESS_TOKEN=<access-token>

(region = us, eu, us-west, etc)

Alternatively, define them in a .env file in the current directory:

API_URL=https://api.<region>.cloud.talend.com
ACCESS_TOKEN=<access-token>

Example CLI Usage

Direct Mode

Run a job by providing --job <name>:

talend_task --wait --job Job1

Interactive Mode

Run the CLI without specifying a job to select and execute one from a menu:

talend_task --wait

Activity Mode

Show recent runs for a job without executing it:

talend_task --activity --job Job1

CLI Screenshots

Interactive Mode

Screenshot

Direct Mode

Screenshot

Activity Mode

Screenshot


Python API Client

Use the TalendClient class to interact with Talend Cloud from Python.

See the API documentation for details.

Example Client Usage

from talend_task import TalendClient

api_url = "https://api.us.cloud.talend.com"
access_token = "SECRET"

with TalendClient(api_url, access_token) as client:
    job_id = client.get_job_id("Job_123")
    status = client.run(job_id, wait=True)

Development

  • Install as editable package with required development/testing dependencies:

    pip install --editable --group dev --group test .
    
  • Run all tests:

    pytest
    
  • Run linting and formatting:

    tox -e lint
    
  • Run validation, linting, formatting, and all tests across all supported/installed Python environments:

    tox
    

Project Structure

./
├── .github/
│   └── workflows/
│       └── docs.yml
│       └── test.yml
├── src/
│   └── talend_task/
│       ├── __init__.py
│       ├── cli.py
│       └── talend_client.py
├── tests/
│   ├── test_cli.py
│   └── test_talend_client.py
├── pyproject.toml
└── tox.ini

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

talend_task-0.1.9.tar.gz (16.0 kB view details)

Uploaded Source

Built Distribution

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

talend_task-0.1.9-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

Details for the file talend_task-0.1.9.tar.gz.

File metadata

  • Download URL: talend_task-0.1.9.tar.gz
  • Upload date:
  • Size: 16.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.6

File hashes

Hashes for talend_task-0.1.9.tar.gz
Algorithm Hash digest
SHA256 691dbe7ff927c022dbbb6775973c670d49f916e6658152ff71571c1c679d1ba3
MD5 12dabe950157635a7d99bf9257cdce97
BLAKE2b-256 36bc5874fe85ad2ccc66d55744e8d5a09f998dd23b9f677177f83316c4912372

See more details on using hashes here.

File details

Details for the file talend_task-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: talend_task-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 10.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.6

File hashes

Hashes for talend_task-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 2ca270c0262a4b15578e2556f69b1ff882f497c8dc59f8ceae264a8c477cfc7f
MD5 a768d2d20c4bcae7059307a2970e4dd4
BLAKE2b-256 a16af6247b47711d0617067e1aeea85608d8c8fb65eb2b249b53a5ccace021c4

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