codeflare-sdk


Namecodeflare-sdk JSON
Version 0.30.0 PyPI version JSON
download
home_pagehttps://github.com/project-codeflare/codeflare-sdk
SummaryPython SDK for codeflare client
upload_time2025-07-08 13:20:55
maintainerNone
docs_urlNone
authorMichael Clifford
requires_python<4.0,>=3.11
licenseApache-2.0
keywords codeflare python sdk client batch scale
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # CodeFlare SDK

[![Python application](https://github.com/project-codeflare/codeflare-sdk/actions/workflows/unit-tests.yml/badge.svg?branch=main)](https://github.com/project-codeflare/codeflare-sdk/actions/workflows/unit-tests.yml)
![coverage badge](./coverage.svg)

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.11",
    "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/f8/05/c5c28624257bbec79216ac9b07fe7c64f61b5188896a4073fbb5c6a20b89/codeflare_sdk-0.30.0.tar.gz",
    "platform": null,
    "description": "# CodeFlare SDK\n\n[![Python application](https://github.com/project-codeflare/codeflare-sdk/actions/workflows/unit-tests.yml/badge.svg?branch=main)](https://github.com/project-codeflare/codeflare-sdk/actions/workflows/unit-tests.yml)\n![coverage badge](./coverage.svg)\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.30.0",
    "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": null,
            "digests": {
                "blake2b_256": "9342ed130972b4dc02e84c26970667e5afdcc5a52ddd21b8fcb5c9a08e2dace5",
                "md5": "8533ff540a36f748590ff05ea8180fc8",
                "sha256": "d7cb1e1d83da104701e5a72124b3545b5a62e3b3e29e1a11edbbc66893f3b645"
            },
            "downloads": -1,
            "filename": "codeflare_sdk-0.30.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8533ff540a36f748590ff05ea8180fc8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.11",
            "size": 134978,
            "upload_time": "2025-07-08T13:20:53",
            "upload_time_iso_8601": "2025-07-08T13:20:53.645129Z",
            "url": "https://files.pythonhosted.org/packages/93/42/ed130972b4dc02e84c26970667e5afdcc5a52ddd21b8fcb5c9a08e2dace5/codeflare_sdk-0.30.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "f805c5c28624257bbec79216ac9b07fe7c64f61b5188896a4073fbb5c6a20b89",
                "md5": "814a2754f1c95ceef10f794d44d1ba42",
                "sha256": "79923eddea43476c65b743c4341d613a39891a04a519720c015a9c28eb0d4b0d"
            },
            "downloads": -1,
            "filename": "codeflare_sdk-0.30.0.tar.gz",
            "has_sig": false,
            "md5_digest": "814a2754f1c95ceef10f794d44d1ba42",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.11",
            "size": 86087,
            "upload_time": "2025-07-08T13:20:55",
            "upload_time_iso_8601": "2025-07-08T13:20:55.428696Z",
            "url": "https://files.pythonhosted.org/packages/f8/05/c5c28624257bbec79216ac9b07fe7c64f61b5188896a4073fbb5c6a20b89/codeflare_sdk-0.30.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-08 13:20:55",
    "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"
}
        
Elapsed time: 0.42802s