# 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 `phoenix_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/detailed-documentation)
## 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.
- Generate new documentation.
`pdoc --html -o docs src/phoenix_sdk && pushd docs && rm -rf cluster job utils && mv phoenix_sdk/* . && rm -rf phoenix_sdk && popd && find docs -type f -name "*.html" -exec bash -c "echo '' >> {}" \;` (it is possible to install **pdoc** using the following command `poetry install --with docs`)
- 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`
- Change directory to custom-nb-image. `cd custom-nb-image`
- Set tag `export tag=TAG`
- Build the container image. `podman build --build-arg SDK_VERSION=<version> -t quay.io/project-codeflare/notebook:${tag} .`
- Login to quay.io. `podman login quay.io`
- Push the image. `podman push quay.io/project-codeflare/notebook:${tag}`
- Push the stable image tag `podman push quay.io/project-codeflare/notebook:${tag} quay.io/project-codeflare/notebook:stable`
Raw data
{
"_id": null,
"home_page": "https://github.com/project-codeflare/codeflare-sdk",
"name": "phoenix-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/c6/91/15d23bec5aac4769536ee98d8d214ec1b99773c4c1293c29b57dbd747ada/phoenix_sdk-0.0.1.dev0.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 `phoenix_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/detailed-documentation)\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- Generate new documentation.\n`pdoc --html -o docs src/phoenix_sdk && pushd docs && rm -rf cluster job utils && mv phoenix_sdk/* . && rm -rf phoenix_sdk && popd && find docs -type f -name \"*.html\" -exec bash -c \"echo '' >> {}\" \\;` (it is possible to install **pdoc** using the following command `poetry install --with docs`)\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- Change directory to custom-nb-image. `cd custom-nb-image`\n- Set tag `export tag=TAG`\n- Build the container image. `podman build --build-arg SDK_VERSION=<version> -t quay.io/project-codeflare/notebook:${tag} .`\n- Login to quay.io. `podman login quay.io`\n- Push the image. `podman push quay.io/project-codeflare/notebook:${tag}`\n- Push the stable image tag `podman push quay.io/project-codeflare/notebook:${tag} quay.io/project-codeflare/notebook:stable`\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Python SDK for codeflare client",
"version": "0.0.1.dev0",
"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": "3cc08205801edae10a53da93a0abb1d29b15e2df641a0518fc0cc6194970af07",
"md5": "fbe776f48b049f6bb9d31a8f0283cb6b",
"sha256": "0edcd1de6565f19e8084f4a5f8b1a2775678a989acbe80266783f17ac4b65f9a"
},
"downloads": -1,
"filename": "phoenix_sdk-0.0.1.dev0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fbe776f48b049f6bb9d31a8f0283cb6b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 37151,
"upload_time": "2024-08-21T10:23:31",
"upload_time_iso_8601": "2024-08-21T10:23:31.835658Z",
"url": "https://files.pythonhosted.org/packages/3c/c0/8205801edae10a53da93a0abb1d29b15e2df641a0518fc0cc6194970af07/phoenix_sdk-0.0.1.dev0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c69115d23bec5aac4769536ee98d8d214ec1b99773c4c1293c29b57dbd747ada",
"md5": "647104c8371962d425dbc3f10d08bf3f",
"sha256": "d83fd831429baf26cb9763505e84f49932a97dbd5fe138db6da036c59ccb7228"
},
"downloads": -1,
"filename": "phoenix_sdk-0.0.1.dev0.tar.gz",
"has_sig": false,
"md5_digest": "647104c8371962d425dbc3f10d08bf3f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 30237,
"upload_time": "2024-08-21T10:23:33",
"upload_time_iso_8601": "2024-08-21T10:23:33.794530Z",
"url": "https://files.pythonhosted.org/packages/c6/91/15d23bec5aac4769536ee98d8d214ec1b99773c4c1293c29b57dbd747ada/phoenix_sdk-0.0.1.dev0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-21 10:23:33",
"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": "phoenix-sdk"
}
JSON
