Hyperscience Flows SDK
The flows_sdk is a Python library for programmatically building flows: sequences of business steps managed and executed by the Hyperscience Platform. These solutions are written in code, but are then manageable on the Hyperscience Platform.
Our documentation consists of the following sections:
Introduction to Flows SDK: Explanations of system architecture, flows_sdk library structure, and basic concepts.
Getting Started: A quickstart guide to deploying your first flow to the Hyperscience Platform.
Command Line Interface: A tutorial for hs-flows - the Flows SDK CLI tool.
Examples: A library of fully executable flow examples. These can be used as templates for developing your own flows.
Getting Started with Testing Flows: A step-by-step introduction to testing flows — setting up a repository, the tests to write for each flow, what to run after a change, and testing on a live instance with synthetic and customer data.
Testing Flows: A comprehensive guide to testing flows across the whole pyramid — unit and component tests with mock objects, stub-free wiring validation, contract snapshots, offline flow-graph tests with
FlowTestRunner, end-to-end tests on a live instance with synthetic data, and in-flow evaluations on customer data that run inside the instance.Custom Supervision: A guide to configuring Custom Supervision templates.
Salesforce Integration Flow: A runnable example of writing extracted data to Salesforce from a flow of your own, driven by the updated Salesforce Notifier output block.
Managing Third-Party Python Packages: A guide to installing/uninstalling third-party Python packages for custom Python Code blocks.
Secure Handling of Secrets: A guide to securely working with secrets like passwords and tokens in your flows. In summary, make sure you never include them directly in your flows or custom code, never commit them in a repository, and never log them. Use fields that have the
"secret": trueproperty instead.FAQ: Answers to frequently asked questions.
Source Documentation & IDP Library: Definitions for all classes and functions in the flows_sdk library.
If you’re using the Flows SDK for the first time, we encourage you to complete the Getting Started tutorial to learn the basics of working with flows.