flux-restful-api

KO | EN

gitlite — search

#javascript #python #react #golang #machine-learning #deep-learning #macos #awesome #cli #awesome-list #vue #pytorch #security #openai

flux-restful-api

(★ 10)

Flux RESTful API provided by FastAPI

flux-restful-api Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Flux RESTFul API

[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](https://raw.githubusercontent.com/flux-framework/flux-restful-api/main/)

[![DOI](https://zenodo.org/badge/561527661.svg)](https://zenodo.org/badge/latestdoi/561527661)

![img/flux-restful-eyes-small.png](https://raw.githubusercontent.com/flux-framework/flux-restful-api/main/img/flux-restful-eyes-small.png)

This is a small Flux Python API (using FastAPI) that can be containerized
alongside Flux, and provide an easy means to interact with Flux via the API.
With Flux RESTful we can:

1. provide simple endpoints to submit jobs, list jobs, or get job status
2. eventually support subscribing to events and a user interface job table
3. option to kill or stop the server (intended for Flux Operator)
4. allow for start with a user name and token (for basic auth)

This project is new and we look forward to [hearing your feedback](https://github.com/flux-framework/flux-restful-api).
See our ⭐️ [Documentation](https://flux-framework.github.io/flux-restful-api) ⭐️ to get started,
and take a look at the [clients](clients) we provide to interact with the server.

![img/flux-restful.png](https://raw.githubusercontent.com/flux-framework/flux-restful-api/main/img/flux-restful.png)

## 😁️ Contributors 😁️

We use the [all-contributors](https://github.com/all-contributors/all-contributors)
tool to generate a contributors graphic below.

<table>
 <tbody>
 <tr>
 <td align="center" valign="top" width="14.28%"><a href="https://vsoch.github.io"><img src="https://avatars.githubusercontent.com/u/814322?v=4?s=100" width="100px;" alt="Vanessasaurus"/> Vanessasaurus</a> <a href="https://github.com/flux-framework/flux-restful-api/commits?author=vsoch" title="Code">💻</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://linkedin.com/in/tgamblin/"><img src="?s=100" width="100px;" alt="Todd Gamblin"/> Todd Gamblin</a> <a href="https://github.com/flux-framework/flux-restful-api/commits?author=tgamblin" title="Code">💻</a></td>
 <td align="center" valign="top" width="14.28%"><a href="https://github.com/khoing0810"><img src="https://avatars.githubusercontent.com/u/47909147?v=4?s=100" width="100px;" alt="Khoi Nguyen"/> Khoi Nguyen</a> <a href="https://github.com/flux-framework/flux-restful-api/commits?author=khoing0810" title="Code">💻</a></td>
 <td align="center" valign="top" width="14.28%"><a href="http://blog.delhomme.org/"><img src="https://avatars.githubusercontent.com/u/1001832?v=4?s=100" width="100px;" alt="dupgit"/> dupgit</a> <a href="https://github.com/flux-framework/flux-restful-api/commits?author=dupgit" title="Code">💻</a></td>
 </tr>
 </tbody>
</table>

Project interaction is governed by a Code of Conduct. Please see our [Code of Conduct](.github/CODE_OF_CONDUCT.md) for contributing.

## LICENSE

DevTools is distributed under the terms of the MIT license.
All new contributions must be made under this license.

See [LICENSE](https://github.com/converged-computing/cloud-select/blob/main/LICENSE),
[COPYRIGHT](https://github.com/converged-computing/cloud-select/blob/main/COPYRIGHT), and
[NOTICE](https://github.com/converged-computing/cloud-select/blob/main/NOTICE) for details.

SPDX-License-Identifier: (MIT)

LLNL-CODE- 842614

flux-restful-api

flux-restful-api Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

flux-restful-api

flux-restful-api Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README