Metadata-Version: 2.4
Name: ironflow-prefect-compat
Version: 0.1.2
Summary: Prefect-style compatibility shim for Project IronFlow (Rust orchestration kernel + Python authoring).
Author: IronFlow contributors
License-Expression: Apache-2.0
Project-URL: Homepage, https://github.com/PPPSDavid/rust-based-prefect
Project-URL: Documentation, https://pppsdavid.github.io/rust-based-prefect/
Project-URL: Repository, https://github.com/PPPSDavid/rust-based-prefect
Project-URL: Issues, https://github.com/PPPSDavid/rust-based-prefect/issues
Project-URL: Changelog, https://github.com/PPPSDavid/rust-based-prefect/blob/main/CHANGELOG.md
Keywords: ironflow,prefect,orchestration,workflow,rust,deterministic
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Rust
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Requires-Dist: pydantic<3,>=2

# ironflow-prefect-compat

**IronFlow** — Prefect-style **`@flow` / `@task`** authoring (`prefect_compat`) backed by a **Rust orchestration kernel** shipped as a **`ctypes`** shared library (`ironflow_engine`).

This PyPI distribution bundles **prebuilt native wheels** per platform where CI publishes them (**CPython 3.11 and 3.12**). You **do not** need Rust installed to **use** those wheels; Rust is used **when building** the package from source.

## Install

**Release validation (TestPyPI)** — use both indices so dependencies resolve:

```bash
python -m pip install --upgrade pip
python -m pip install \
  --index-url https://test.pypi.org/simple/ \
  --extra-index-url https://pypi.org/simple/ \
  ironflow-prefect-compat
```

**Production PyPI** (`pypi.org`), after maintainers publish wheels:

```bash
python -m pip install --upgrade pip
python -m pip install ironflow-prefect-compat
```

## Verify the native library

```bash
python -c "from prefect_compat.rust_bridge import native_library_available; print(native_library_available())"
```

Expect **`True`** when the wheel matched your platform. If **`False`**, set **`IRONFLOW_RUST_LIB`** to a built `ironflow_engine` library or see the full docs.

## Documentation

- **User install & matrices:** [Installation](https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/INSTALL.md)
- **Hosted docs:** [https://pppsdavid.github.io/rust-based-prefect/](https://pppsdavid.github.io/rust-based-prefect/)
- **Repository / issues:** [github.com/PPPSDavid/rust-based-prefect](https://github.com/PPPSDavid/rust-based-prefect)
- **Compatibility vs Prefect:** [COMPATIBILITY.md](https://github.com/PPPSDavid/rust-based-prefect/blob/main/COMPATIBILITY.md)

## License

Apache-2.0 — see the repository **`LICENSE`** file.
