# CodeFlare SDK
[](https://github.com/project-codeflare/codeflare-sdk/actions/workflows/unit-tests.yml)
An intuitive, easy-to-use python interface for batch resource requesting, access, job submission, and observation. Simplifying the developer's life while enabling access to high-performance compute resources, either in the cloud or on-prem.
For guided demos and basics walkthroughs, check out the following links:
- Guided demo notebooks available [here](https://github.com/project-codeflare/codeflare-sdk/tree/main/demo-notebooks/guided-demos), and copies of the notebooks with [expected output](https://github.com/project-codeflare/codeflare-sdk/tree/main/demo-notebooks/guided-demos/notebook-ex-outputs) also available
- these demos can be copied into your current working directory when using the `codeflare-sdk` by using the `codeflare_sdk.copy_demo_nbs()` function
- Additionally, we have a [video walkthrough](https://www.youtube.com/watch?v=U76iIfd9EmE) of these basic demos from June, 2023
Full documentation can be found [here](https://project-codeflare.github.io/codeflare-sdk/index.html)
## Installation
Can be installed via `pip`: `pip install codeflare-sdk`
## Development
Please see our [CONTRIBUTING.md](./CONTRIBUTING.md) for detailed instructions.
## Release Instructions
### Automated Releases
It is possible to use the Release Github workflow to do the release. This is generally the process we follow for releases
### Manual Releases
The following instructions apply when doing release manually. This may be required in instances where the automation is failing.
- Check and update the version in "pyproject.toml" file.
- Commit all the changes to the repository.
- Create Github release (<https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release>).
- Build the Python package. `poetry build`
- If not present already, add the API token to Poetry.
`poetry config pypi-token.pypi API_TOKEN`
- Publish the Python package. `poetry publish`
- Trigger the [Publish Documentation](https://github.com/project-codeflare/codeflare-sdk/actions/workflows/publish-documentation.yaml) workflow
Raw data
{
"_id": null,
"home_page": "https://github.com/project-codeflare/codeflare-sdk",
"name": "codeflare-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "codeflare, python, sdk, client, batch, scale",
"author": "Michael Clifford",
"author_email": "mcliffor@redhat.com",
"download_url": "https://files.pythonhosted.org/packages/7c/51/2f70bc185e7c5e98f5c15eb66092609eb50db6c18c8e9d97aa90b22cdda3/codeflare_sdk-0.24.3.tar.gz",
"platform": null,
"description": "# CodeFlare SDK\n\n[](https://github.com/project-codeflare/codeflare-sdk/actions/workflows/unit-tests.yml)\n\n\nAn intuitive, easy-to-use python interface for batch resource requesting, access, job submission, and observation. Simplifying the developer's life while enabling access to high-performance compute resources, either in the cloud or on-prem.\n\nFor guided demos and basics walkthroughs, check out the following links:\n\n- Guided demo notebooks available [here](https://github.com/project-codeflare/codeflare-sdk/tree/main/demo-notebooks/guided-demos), and copies of the notebooks with [expected output](https://github.com/project-codeflare/codeflare-sdk/tree/main/demo-notebooks/guided-demos/notebook-ex-outputs) also available\n- these demos can be copied into your current working directory when using the `codeflare-sdk` by using the `codeflare_sdk.copy_demo_nbs()` function\n- Additionally, we have a [video walkthrough](https://www.youtube.com/watch?v=U76iIfd9EmE) of these basic demos from June, 2023\n\nFull documentation can be found [here](https://project-codeflare.github.io/codeflare-sdk/index.html)\n\n## Installation\n\nCan be installed via `pip`: `pip install codeflare-sdk`\n\n## Development\n\nPlease see our [CONTRIBUTING.md](./CONTRIBUTING.md) for detailed instructions.\n\n## Release Instructions\n\n### Automated Releases\n\nIt is possible to use the Release Github workflow to do the release. This is generally the process we follow for releases\n\n### Manual Releases\n\nThe following instructions apply when doing release manually. This may be required in instances where the automation is failing.\n\n- Check and update the version in \"pyproject.toml\" file.\n- Commit all the changes to the repository.\n- Create Github release (<https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release>).\n- Build the Python package. `poetry build`\n- If not present already, add the API token to Poetry.\n`poetry config pypi-token.pypi API_TOKEN`\n- Publish the Python package. `poetry publish`\n- Trigger the [Publish Documentation](https://github.com/project-codeflare/codeflare-sdk/actions/workflows/publish-documentation.yaml) workflow\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Python SDK for codeflare client",
"version": "0.24.3",
"project_urls": {
"Homepage": "https://github.com/project-codeflare/codeflare-sdk",
"Repository": "https://github.com/project-codeflare/codeflare-sdk"
},
"split_keywords": [
"codeflare",
" python",
" sdk",
" client",
" batch",
" scale"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c27807a74c12f929d84da58df3c0ff3743ff82347b64d8e8d5f12b96af1dae4a",
"md5": "ca70c990f2253fb0a3301c7995017cc2",
"sha256": "f357e3f0d74013194e0ecadb82d3309182053a0f9c2003f34cafa25109a404bb"
},
"downloads": -1,
"filename": "codeflare_sdk-0.24.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ca70c990f2253fb0a3301c7995017cc2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 128857,
"upload_time": "2024-12-18T16:13:14",
"upload_time_iso_8601": "2024-12-18T16:13:14.879346Z",
"url": "https://files.pythonhosted.org/packages/c2/78/07a74c12f929d84da58df3c0ff3743ff82347b64d8e8d5f12b96af1dae4a/codeflare_sdk-0.24.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7c512f70bc185e7c5e98f5c15eb66092609eb50db6c18c8e9d97aa90b22cdda3",
"md5": "1770e9e8e5350bc0d54a19429bf786cf",
"sha256": "65f1c97ea8e00b3598308504a358645d61031da3e849ef89a4cc13d2ea4823dc"
},
"downloads": -1,
"filename": "codeflare_sdk-0.24.3.tar.gz",
"has_sig": false,
"md5_digest": "1770e9e8e5350bc0d54a19429bf786cf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 80385,
"upload_time": "2024-12-18T16:13:16",
"upload_time_iso_8601": "2024-12-18T16:13:16.416341Z",
"url": "https://files.pythonhosted.org/packages/7c/51/2f70bc185e7c5e98f5c15eb66092609eb50db6c18c8e9d97aa90b22cdda3/codeflare_sdk-0.24.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-18 16:13:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "project-codeflare",
"github_project": "codeflare-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "codeflare-sdk"
}
JSON
