flux-framework / flux-docs

Documentation for the Flux-Framework
https://flux-framework.readthedocs.io/
Other
12 stars 21 forks source link

add start of language bindings #234

Open vsoch opened 1 year ago

vsoch commented 1 year ago

This is the start of a (likely multiple PR/ multiple repository) to refactor / create a set of language bindings tutorials/snippets. Importantly, each is a separate repository that (akin to what the page says) includes:

The high level goal is that a contributor developer could fork/clone one of these repos and jump in to developing their project that uses flux without having to untangle or otherwise figure out the logic from our main repos. These repos are separate, but importantly they are regularly tested so they don't get out of date. This (I hope) achieves a balance of allowing separation without burdening the main flux core devs with extra work.

For the main plan, since we already have some Python here, this is my proposal. Under tutorials I think we should remove the top group that we currently have for the "Python API" and move these examples into their own repository. Then, we can link (to start) each of the external repos for C/C++, Python, and Go (and TBA others) like this:

image

I put it first there because that's where Python currently is, it doesn't need to be.

Let me know your thoughts on this! If you like the idea, my proposal is to review/merge here, and then I can start refactoring our Python examples here to be in a separate repository, and (in the meantime) if someone else wants to make a simple repository with a src folder and Makefile for C/C++, I can add the developer environment, docs, and automation around that.