Metadata-Version: 2.3
Name: rippling-flux-sdk
Version: 0.63.123
Summary: Defines the interfaces and data-models used by Rippling Flux Apps.
Author: Rippling Apps
Author-email: apps@rippling.com
Requires-Python: >=3.10,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: click (>=8.0,<9)
Requires-Dist: pydantic-core
Requires-Dist: pydantic[email] (==2.11.0)
Requires-Dist: ruamel.yaml (==0.17.10)
Description-Content-Type: text/markdown

# rippling-flux-sdk

Defines the interfaces and data-models used by Rippling Flux Apps.

The **distribution name** for this project is `rippling-flux-sdk`, which is how it is listed in PyPI. Once added as a
dependency though, use the name `flux_sdk` as the **import name**.

The imports for this package should be included in the scaffolding for a Flux App, in general Flux app developers will
not need to write that code. By being distributed as a package, it will allow your IDE to inspect the defined types for
additional context.


## Getting Started

Code is linted with ruff.  It's recommended to run `./install_hooks.sh` to run linting on commit.
Linting can also be run manually with `./run_ruff.sh`.  In many cases it's possible to auto-fix
linting errors with `./run_ruff.sh --fix`.

