index.markdown

layout	title	description	navlevel
docs	IBM Streams documentation	IBM Streams community-based documentation project.	3

The streamsx.documentation is a community-based documentation project for IBM Streams. The goal of the project is to provide easy-to-follow documentation and development guides to help users get started with Streams.

Getting started with IBM Streams

Streams applications can be developed in Python, Java, and the Streams Processing Language (SPL).

The following are resources to help you get started developing applications using your language of choice.

Developing Streams applications with Python

{: .simple}

• Development guide for Python applications
• API reference

Developing Streams applications with SPL

Streams Processing Language is specifically designed for creating Streams applications. You can use Visual Studio Code (VS Code) or Streams Studio to get started. Streams Studio provides a full IDE with a graphical drag-and-drop editor.

{: .simple}

• Start here: If you are new to SPL, start with this guide.

Developing Streams applications with Java

{: .simple}

• Create a Java operator or a complete Streams application in Java

Developing Streams applications with Scala

{: .simple}

• Developing applications with Scala

Developing Streams applications for edge analytics

{: .simple}

• Developing applications for edge analytics

Quick links

{: .simple}

• Download the Streams Quick Start Edition

• Search our samples catalog

• Streams in IBM Cloud Pak for Data

• Streams Knowledge Center

• Streams Studio Tutorial

Integrating with Streams

There are toolkits available to help you integrate Streams with popular systems like JMS, Kafka, and more.

Some toolkits are included with Streams, and others are available on GitHub.

Links to common toolkits

{: .simple}

• Connect to Apache Kafka using the Kafka toolkit

• Get started with the JMS toolkit

• Use models created with SPSS Modeler in a Streams application

• HBase toolkit

• HDFS toolkit

• JDBC toolkit

Full list of available toolkits

{: .simple}

• Product toolkits

• List of all open source toolkits on GitHub

Streams 4.2 and 4.1

{: .simple}

• Tutorials and guides for older versions of IBM Streams.

Further documentation

View the IBM Streams product documentation on IBM Knowledge Center.

{: .simple}

• Monitor access to your data with IBM Information Governance catalog

• IBM Knowledge Center > IBM Streams

Need help?

1. Ask your questions on the Streams Forum.
2. If your project is on IBM Streams GitHub, open an issue to the related project.
3. Ask your questions on StackOverflow.

Contributing

If you have ideas on how we can better document or explain some of the concepts, we would love to have your contribution. The streamsx.documentation site uses GitHub Pages and Jekyll markdown.

To contribute, you have two options:

• Clone this project locally, make your changes, and create a pull request.
• Click Edit Me and then click Edit this file to make changes directly in your browser.

For more information about contributing to this project, see Contribute to an IBM Streams GitHub project.

For more information about GitHub Markdown, see Writing on GitHub.

For more information about using Jekyll with GitHub Pages, see Using Jekyll as a static site generator with GitHub Pages.

Providing feedback

To provide feedback on the documentation:

1. Go to the documentation page that you want to provide feedback for.
2. Click Feedback to open an issue for the page that you are currently viewing.

New documentation

To request new documentation, open an issue by clicking New documentation: