Ironclad / Ironclad/rivet

[Feature]: Documentation on running graphs created in Rivet using Python

Open
#169 1 comment 1 reaction 0 assignees View on GitHub
enhancement
Dominant language
TypeScript
Stars
4.7k
Forks
388
PR merge metrics
No merged PRs in 30d

Description

### Feature Request

Super neat project, thanks for open-sourcing! In the Show HN Hacker News post [here](https://news.ycombinator.com/item?id=37433218), it says:

> Finally, Rivet is built to be embedded into a larger application (TypeScript for now, but we've also found a way to run it in Python).

I couldn't find any documentation on how to run a Rivet graph via Python (though I did find the example project for executing Python code via Rivet https://github.com/abrenneke/rivet-plugin-example-python-exec). Would it be possible to share how you're running these graphs with Python instead of TypeScript?

Also, I expect it may not be likely, but are there any plans for first-class Python support in the future?

### Code of Conduct

- [X] I agree to follow this project's Code of Conduct

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the Rivet project’s existing embedding documentation and the linked rivet-plugin-example-python-exec project to identify how Python currently interacts with Rivet graphs. Document the supported way to run a graph from Python, including prerequisites and an example, and clarify whether first-class Python support is planned.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, typescript
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.