# flux-framework fluxoperator
> Python SDK for Flux-Operator
## Requirements.
Python >= 3.6
## Installation & Usage
### pip install
You can install directly from the git subfolder like:
```bash
pip install git+https://github.com/flux-framework/flux-operator.git#egg=subdir&subdirectory=sdk/python/v1alpha1
```
or install from pip:
```bash
$ pip install fluxoperator
```
Then import the package:
```python
import fluxoperator
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import fluxoperator
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import time
import fluxoperator
from pprint import pprint
```
## Documentation For Models
- [BurstedCluster](BurstedCluster.md)
- [Bursting](Bursting.md)
- [Commands](Commands.md)
- [ContainerResources](dContainerResources.md)
- [ContainerVolume](ContainerVolume.md)
- [FluxBroker](FluxBroker.md)
- [FluxContainer](FluxContainer.md)
- [FluxRestful](FluxRestful.md)
- [FluxScheduler](FluxScheduler.md)
- [FluxSpec](FluxSpec.md)
- [FluxUser](FluxUser.md)
- [LifeCycle](LifeCycle.md)
- [LoggingSpec](LoggingSpec.md)
- [MiniCluster](MiniCluster.md)
- [MiniClusterArchive](MiniClusterArchive.md)
- [MiniClusterContainer](MiniClusterContainer.md)
- [MiniClusterList](MiniClusterList.md)
- [MiniClusterSpec](MiniClusterSpec.md)
- [MiniClusterStatus](MiniClusterStatus.md)
- [MiniClusterUser](MiniClusterUser.md)
- [Network](Network.md)
- [PodSpec](PodSpec.md)
- [Secret](Secret.md)
- [SecurityContext](SecurityContext.md)
## Documentation For Authorization
All endpoints do not require authorization (but they do require you have permission via your kubernetes config)
## Author
- [@vsoch](https://github.com/vsoch)
Raw data
{
"_id": null,
"home_page": "https://github.com/flux-framework/flux-operator/tree/main/python-sdk/v1alpha2",
"name": "fluxoperator",
"maintainer": "Vanessasaurus",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "flux-operator,flux-framework,kubernetes,workflows,jobs-api",
"author": "Vanessasaurus",
"author_email": "vsoch@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/59/59/015f0f10c7e85c6ca3c405ccad62645edd3738fad882c5c3b829f64fa4a7/fluxoperator-0.2.0.tar.gz",
"platform": null,
"description": "# flux-framework fluxoperator\n\n> Python SDK for Flux-Operator\n\n## Requirements.\n\nPython >= 3.6\n\n## Installation & Usage\n\n### pip install\n\nYou can install directly from the git subfolder like:\n\n```bash\npip install git+https://github.com/flux-framework/flux-operator.git#egg=subdir&subdirectory=sdk/python/v1alpha1\n```\n\nor install from pip:\n\n```bash\n$ pip install fluxoperator\n```\n\nThen import the package:\n\n```python\nimport fluxoperator\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n\n```python\nimport fluxoperator\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\nimport time\nimport fluxoperator\nfrom pprint import pprint\n```\n\n## Documentation For Models\n\n - [BurstedCluster](BurstedCluster.md)\n - [Bursting](Bursting.md)\n - [Commands](Commands.md)\n - [ContainerResources](dContainerResources.md)\n - [ContainerVolume](ContainerVolume.md)\n - [FluxBroker](FluxBroker.md)\n - [FluxContainer](FluxContainer.md)\n - [FluxRestful](FluxRestful.md)\n - [FluxScheduler](FluxScheduler.md)\n - [FluxSpec](FluxSpec.md)\n - [FluxUser](FluxUser.md)\n - [LifeCycle](LifeCycle.md)\n - [LoggingSpec](LoggingSpec.md)\n - [MiniCluster](MiniCluster.md)\n - [MiniClusterArchive](MiniClusterArchive.md)\n - [MiniClusterContainer](MiniClusterContainer.md)\n - [MiniClusterList](MiniClusterList.md)\n - [MiniClusterSpec](MiniClusterSpec.md)\n - [MiniClusterStatus](MiniClusterStatus.md)\n - [MiniClusterUser](MiniClusterUser.md)\n - [Network](Network.md)\n - [PodSpec](PodSpec.md)\n - [Secret](Secret.md)\n - [SecurityContext](SecurityContext.md)\n\n## Documentation For Authorization\n\n All endpoints do not require authorization (but they do require you have permission via your kubernetes config)\n\n## Author\n\n- [@vsoch](https://github.com/vsoch)\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Python SDK for the Flux Operator",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/flux-framework/flux-operator/tree/main/python-sdk/v1alpha2"
},
"split_keywords": [
"flux-operator",
"flux-framework",
"kubernetes",
"workflows",
"jobs-api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d541ce76a9468041755195f3d094db88dbfc1cf3b815b7d760cdf0f2bbf8da13",
"md5": "928444b4542685a09bb42ff46bcc367d",
"sha256": "79a0ca8a43481583bcadd0b691a8683593266f9087262e8da4dda0f518e6cee8"
},
"downloads": -1,
"filename": "fluxoperator-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "928444b4542685a09bb42ff46bcc367d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 98625,
"upload_time": "2024-03-18T00:24:43",
"upload_time_iso_8601": "2024-03-18T00:24:43.564992Z",
"url": "https://files.pythonhosted.org/packages/d5/41/ce76a9468041755195f3d094db88dbfc1cf3b815b7d760cdf0f2bbf8da13/fluxoperator-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5959015f0f10c7e85c6ca3c405ccad62645edd3738fad882c5c3b829f64fa4a7",
"md5": "09f89f4943f64e43bea323b048ef0dc1",
"sha256": "0575af0d188e89b7b69f0ef9820e95435ddfa48277902b44765a0f683b7dfab8"
},
"downloads": -1,
"filename": "fluxoperator-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "09f89f4943f64e43bea323b048ef0dc1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 51396,
"upload_time": "2024-03-18T00:24:54",
"upload_time_iso_8601": "2024-03-18T00:24:54.463461Z",
"url": "https://files.pythonhosted.org/packages/59/59/015f0f10c7e85c6ca3c405ccad62645edd3738fad882c5c3b829f64fa4a7/fluxoperator-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-18 00:24:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "flux-framework",
"github_project": "flux-operator",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "fluxoperator"
}
JSON
