Metadata-Version: 2.4
Name: rippling-flux-sdk
Version: 0.68.138
Summary: Defines the interfaces and data-models used by Rippling Flux Apps.
License-File: LICENSE
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
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: certifi (>=2025.4.26)
Requires-Dist: charset-normalizer (>=2.1.1)
Requires-Dist: click (>=8.0,<9)
Requires-Dist: grpcio (>=1.56.2)
Requires-Dist: idna (>=2.10)
Requires-Dist: protobuf (>=4.23.4)
Requires-Dist: pydantic-core
Requires-Dist: pydantic[email] (>=2.11.0)
Requires-Dist: pyrfc3339 (>=2.0.1)
Requires-Dist: requests (>=2.31.0)
Requires-Dist: rp-twirp (==1.1.1)
Requires-Dist: ruamel.yaml (>=0.17.10)
Requires-Dist: structlog (>=21.5.0)
Requires-Dist: urllib3 (>=1.26.18)
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.


## Installing Dependencies

To install the project dependencies:

1. Run `cde aws codeartifact auth` to authenticate with AWS CodeArtifact
2. Export the environment variables from the command output:
   ```bash
   export POETRY_HTTP_BASIC_PYRIPPLER_USERNAME=<username>
   export POETRY_HTTP_BASIC_PYRIPPLER_PASSWORD=<password>
   ```
3. Run `poetry install` to install all dependencies


## 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`.

