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.

• Unit Testing Custom Code Blocks: A comprehensive guide to testing custom code blocks using mock objects and best practices for module-backed CCBs.

• Custom Supervision: A guide to configuring Custom Supervision templates.

• 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": true property 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.