https://github.com/project-codeflare/codeflare-sdk

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.
https://github.com/project-codeflare/codeflare-sdk

Last synced: 4 days ago
JSON representation

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.

• Host: GitHub
• URL: https://github.com/project-codeflare/codeflare-sdk
• Owner: project-codeflare
• License: apache-2.0
• Created: 2022-10-24T17:00:43.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T08:55:03.000Z (about 2 months ago)
• Last Synced: 2024-10-29T09:21:58.582Z (about 2 months ago)
• Language: Python
• Homepage:
• Size: 5.59 MB
• Stars: 22
• Watchers: 15
• Forks: 44
• Open Issues: 88
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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 ().

- 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