IBM Streams Python support — streamsx 1.15.9 documentation

# IBM Streams Python support

Python APIs for use with IBM® Streaming Analytics service on IBM Cloud and on-premises IBM Streams.

## Python Application API for Streams

Module that allows the definition and execution of streaming applications implemented in Python. Applications use Python code to process tuples and tuples are Python objects.

SPL operators may also be invoked from Python applications to allow use of existing IBM Streams toolkits.

See `topology`

`streamsx.topology` | Python application support for IBM Streams.
`streamsx.topology.topology` | Streaming application definition.
`streamsx.topology.context` | Context for submission and build of topologies.
`streamsx.topology.schema` | Schemas for streams.
`streamsx.topology.state` | Application state.
`streamsx.topology.composite` | Composite transformations.
`streamsx.topology.tester` | Testing support for streaming applications.
`streamsx.topology.tester_runtime` | Runtime tester functionality.
`streamsx.ec` | Access to the IBM Streams execution context.
`streamsx.spl.op` | Integration of SPL operators.
`streamsx.spl.types` | SPL type definitions.
`streamsx.spl.toolkit` | SPL toolkit integration.

## SPL primitive Python operators

SPL primitive Python operators provide the ability to perform tuple processing using Python in an SPL application.

A Python function or class is simply turned into an SPL primitive operator through provided decorators.

SPL (Streams Processing Language) is a domain specific language for streaming analytics supported by Streams.

`streamsx.spl.spl` | SPL Python primitive operators.

## Streams Python REST API

Module that allows interaction with an running Streams instance or service through HTTPS REST APIs.

`streamsx.build` | REST API bindings for IBM® Streams Cloud Pak for Data build service.
`streamsx.rest` | REST API bindings for IBM® Streams & Streaming Analytics service.
`streamsx.rest_primitives` | Primitive objects for REST bindings.

## Scripts

The streamsx package provides a number of command line scripts.

- spl-python-extract
  - Overview
  - Usage
  - SPL Python primitive operators
- streamsx-info
  - Overview
  - Usage
- streamsx-runner
  - Overview
  - Streaming Analytics service
  - Job submission
  - Bundle creation
  - Usage
  - Submitting to Streaming Analytics service
    - Python applications
    - SPL applications
    - Streams application bundles
    - Job options
  - Creating Streams application bundles
- streamsx-sc
  - Overview
    - Cloud Pak for Data configuration
      - Integrated configuration
      - Standalone configuration
  - Usage
  - Toolkits
- streamsx-service
  - Overview
  - Usage
  - Controlling a Streaming Analytics service
- streamsx-streamtool
  - Overview
    - Cloud Pak for Data configuration
      - Integrated configuration
      - Standalone configuration
  - Usage
  - submitjob
  - canceljob
  - lsjobs
  - lsappconfig
  - mkappconfig
  - rmappconfig
  - chappconfig
  - getappconfig
  - lstoolkit
  - rmtoolkit
  - uploadtoolkit
  - updateoperators

## Environments

- IBM Streaming Analytics service
  - Overview
  - Package support
  - Accessing a service
    - VCAP services
      - Cloud Foundry applications
      - Client applications
      - Selecting the service
    - Service definition
- IBM Streams Python setup
  - Developer setup
  - Streaming Analytics service
  - IBM Cloud Pak for Data
  - IBM Streams 4.2, 4.3
    - Distributed
    - Standalone
  - Bundle Python version compatibility

## Restrictions and known bugs

- Restrictions and known bugs

### Indices and tables

- Index

- Module Index

- Search Page