Flux RESTFul API
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:
- provide simple endpoints to submit jobs, list jobs, or get job status
- eventually support subscribing to events and a user interface job table
- option to kill or stop the server (intended for Flux Operator)
- allow for start with a user name and token (for basic auth)
Install the server with pip install flux-restful (the Flux Python bindings come with
Flux itself) and start it under a Flux instance with flux start flux-restful serve.
This project is new and we look forward to hearing your feedback. See our ⭐️ Documentation ⭐️ to get started, and take a look at the clients we provide to interact with the server.
😁️ Contributors 😁️
We use the all-contributors tool to generate a contributors graphic below.
 Vanessasaurus 💻 |
 Todd Gamblin 💻 |
 Khoi Nguyen 💻 |
 dupgit 💻 |
Project interaction is governed by a Code of Conduct. Please see our Code of Conduct for contributing.
LICENSE
DevTools is distributed under the terms of the MIT license. All new contributions must be made under this license.
See LICENSE, COPYRIGHT, and NOTICE for details.
SPDX-License-Identifier: (MIT)
LLNL-CODE- 842614
1 maintainer
Metadata
1 maintainer
Release files for flux-restful 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| flux_restful-1.0.0.tar.gz | 64.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| flux_restful-1.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 129.7 kB
Release files / flux_restful-1.0.0.tar.gz
| Download URL | flux_restful-1.0.0.tar.gz |
|---|---|
| Size | 64.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f4941662f13cf307b5a186775ffc605f122f86cb14eb35f1ec10920195f0e01e
|
|
BLAKE2b-256 checksum How to use checksums |
047cdb5842818236890ebaab9488910a62b31dbac0ff5967defc6916b0c28642
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.2
|
Release files / flux_restful-1.0.0-py3-none-any.whl
| Download URL | flux_restful-1.0.0-py3-none-any.whl |
|---|---|
| Size | 65.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d560c638ef43a5ba55e367f6c639be50743f1ef22b4d4aa6333a8f0e485ce09a
|
|
BLAKE2b-256 checksum How to use checksums |
f2815f0e322266df25f3e35e892436606dc7b1e737a6045867c0dcf63f841952
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.2
|
