Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add start of language bindings #234

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

add start of language bindings #234

wants to merge 1 commit into from

Conversation

vsoch
Copy link
Member

@vsoch vsoch commented Apr 29, 2023

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:

  • examples and snippets
  • developer environment
  • build setup for compiling
  • CI with automated container build and testing
  • web interface to render snippets (or for the user, they could use it for docs)

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.

We can host external tutorials for bindings that
are well-tested, etc. I will include my proposal for
a plan in the pull request associated with this PR

Signed-off-by: vsoch <vsoch@users.noreply.github.com>
@vsoch vsoch requested a review from grondo May 18, 2023 20:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant