/buildflow

BuildFlow, is an open source framework for building large scale systems using Python. All you need to do is describe where your input is coming from and where your output should be written, and BuildFlow handles the rest. No configuration outside of the code is required.

Primary LanguagePythonApache License 2.0Apache-2.0

⚒️ BuildFlow

CI Release Tests Python version codecov Discord Shield

Overview

BuildFlow, is an open source framework for building large scale systems using Python. All you need to do is describe where your input is coming from and where your output should be written, and BuildFlow handles the rest. No configuration outside of the code is required.

Key Features (all provided out-of-the-box):

Installation

pip install buildflow

Extra Dependencies

Pulumi Installation

BuildFlow uses Pulumi to manage resources used by your BuildFlow Nodes and Processors. To install Pulumi visit: https://www.pulumi.com/docs/install/

Installing Pulumi unlocks:

  • allows BuildFlow to manage resource creation and destruction
  • full access to Pulumi API / CLI
  • fine-grained control over Pulumi Stacks & Resources

Quick Links

Code Health Checks

We use black and ruff with pre-commit hooks to perform health checks. To setup these locally:

  • Clone the repo
  • Install the dev dependencies like `python -m pip install .[dev]
  • Check if pre-commit is installed correctly by running pre-commit --version
  • Setup pre-commit to run before every commit on staged changes by running pre-commit install
  • Pre-commit can also be ran manually as pre-commit run --all-files