Build Scramjet with Us!We're hiring

Samples 📚

We have prepared some samples for you that show the different uses of a Sequence. Some are super simple, some are a little more advanced. They show the use of data from various resources, such as local disk, external API, or plain keyboard input. The samples are differentiated according to language in which they were written. Every sample contains a short readme with a guidance describing the procedure for running the example as well as is linked to its source code on GitHub. Please take a look at our samples and if you have any questions or difficulties, feel free to ask us on Discord.

The execution will be performed from the command line using our CLI, which full description and documentation you will find in CLI Reference. In samples we are using methods and definitions described in APP Reference.

Prerequisites

Sample execution requires prior environment preparation and installations.

Environment

You can run each sample either on your Self Hosted Hub or Scramjet Cloud Platform. Choose the most suitable for you and follow the link that provides installation tips and guidelines:

Command Line Interface

Samples execution will be performed from the command line using our CLI, which full description you will find in our official documentation website in CLI Reference section, or run si --help command where you have everything in a nutshell.

You can install the si command from npm using the following command:

npm i -g @scramjet/cli

Repository

Please clone our GitHub platform-samples repository:

git clone https://github.com/scramjetorg/platform-samples.git

Show samples:

#javascript#python#typescript

javascript samples

hello

Sequence that modifies incoming stream of strings by adding Hello.

SourceCheck sample

hello-world-js

Simple Sequence that prints out 'Hello World!' to the Instance output.

SourceCheck sample

json-url-output

Sequence that pulls data from JSON url every x seconds and writes it to Instance output endpoint.

SourceCheck sample

json-url-stdout

Sequence that pulls data from JSON url every x seconds and writes it to Instance stdout endpoint.

SourceCheck sample

pokemon

A Sequence that reads incoming data via input stream, then based on that data, a request is sent to external API.

SourceCheck sample

simple-counter-js

A simple Sequence, that counts and logs the number in 1s intervals.

SourceCheck sample

test-output

Sequence that writes random values to output stream.

SourceCheck sample

python samples

stripe-read

Reading from stripe

SourceCheck sample

mailchimp-insert

Insert users to mailchimp

SourceCheck sample

stripe

Read users from stripe

SourceCheck sample

python-co2-emission

Sequent Python-CO2-Emission is a Python library that fetches CO2 emission information from an API, enabling easy access and analysis of carbon dioxide data.

SourceCheck sample

gh-issues-to-clickup

Sequence that sends GitHub issues to dedicated ClickUp list.

SourceCheck sample

hello-world-py

Simple Sequence that prints out 'Hello World!' to the Instance output.

SourceCheck sample

python-kafka-consumer

Sequence that can retrieve data from Kafka topic and show the result on 'output'.

SourceCheck sample

python-kafka-transformer

Sequence that can send data to Kafka topic from input.

SourceCheck sample

python-markdown-keywords

Sequence that suggests keywords for header in *.md. This is also an easy example of usage Kaffka with Scramjet platform.

SourceCheck sample

fetch-stuctures-xml

Removes certain XML tags from a valid xml file

SourceCheck sample

rpilocator-scraper

rpilocator.com in-stock watcher.

SourceCheck sample

fire-alert

raspberry pi internal parameters fetcher example

SourceCheck sample

telegram-read

Read last message from telegram channel.

SourceCheck sample

telegram-write

Forwards input to a specified telegram channel.

SourceCheck sample

python-voice-recognition

This Sequence is a trivial example of voice recognition with Scramjet and speech_recognition Python library.

SourceCheck sample

typescript samples

audio2text

SourceCheck sample

crypto-prices

Sequence that keeps printing current crypto prices for a provided pair of currencies every 1s.

SourceCheck sample

discord-read

Sequence that reads messages from Discord channel and writes to topic.

SourceCheck sample

discord-write

Sequence that reads messages from topic and writes to Discord via webhook.

SourceCheck sample

hello-world-ts

Simple Sequence that prints out 'Hello World!' to the Instance output.

SourceCheck sample

hexdump

A simple Sequence that takes file as an input and returns a hexadecimal view of this file on output.

SourceCheck sample

linkedin

This sequence processes CSV input and retrieves additional company data from LinkedIn via RapidAPI

SourceCheck sample

mediawiki

Sequence that keeps printing mediawiki event stream.

SourceCheck sample

read-targz-stats

Sequence that reads tar.gz file from input and returns JSON containing basic information about archived files along with unpacked data.

SourceCheck sample

rss

A Sequence that works as a web feed, monitors website for a new content.

SourceCheck sample

scraping

This is a simple and trivial example of scraping web pages.

SourceCheck sample

send-to-github

A Sequence that commits a JSON object to a file on Github

SourceCheck sample

slack-read

Sequence that reads messages from Slack and writes to topic.

SourceCheck sample

stack-overflow

This a Sequence that gets the number of changes in Stack Overflow tag count. This queries SO API every x minutes, gathers, compares and outputs result as difference.

SourceCheck sample

transform-string-stream

Sequence that modifies incoming stream of strings by adding a prefix and a suffix.

SourceCheck sample

slack-write

Sequence that reads messages from topic and writes to Slack.

SourceCheck sample

write-to-database

Sequence that writes data to SQL database

SourceCheck sample

Was it helpful?

Yes No

Didn't find information needed?

Join our Scramjet Community on Discord, where you can get help from our engineers directly.

JOIN