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.
For guided demos and basics walkthroughs, check out the following links:
- Guided demo notebooks available here, and copies of the notebooks with expected output also available
- Note that these notebooks will work with the latest
codeflare-sdkPyPI release. For testing and experimentation withmainbranch, please use the preview notebooks - Additionally, we have a video walkthrough of these basic demos from June, 2023
Full documentation can be found here
Installation
Can be installed via pip: pip install codeflare-sdk
Development
Prerequisites
We recommend using Python 3.9 for development, along with Poetry. Create a Poetry virtual environment with the required Python version 3.9, and run all commands within this environment.
- run:
poetry shell
Install dependencies:
- run:
poetry install
This will install standard requirements as specified in the poetry.lock file. Test and docs dependencies are optional.
-
To include test dependencies run:
poetry install --with test -
To include docs dependencies run:
poetry install --with docs -
To include test and docs dependencies run:
poetry install --with test,docs
If you require a requirements.txt file you can run:
poetry export -f requirements.txt --output requirements.txt --without-hashes
Pre-commit
We use pre-commit to make sure the code is consistently formatted. To make sure that pre-commit is run every time you commit changes, simply run pre-commit install
To build the codeflare-sdk pre-commit image run podman build -f .github/build/Containerfile . from the root directory.
Testing
- To install codeflare-sdk in editable mode, run
pip install -e .from the repo root. - Any new test functions/scripts can be added into the
testsfolder - NOTE: Functional tests coming soon, will live in
tests/func_test.py
Unit Testing
- To run the unit tests, run
pytest -v tests/unit_test.py
Local e2e Testing
- Please follow the e2e documentation
Code Coverage
- Run tests with the following command:
coverage run -m --source=src pytest tests/unit_test.py - To then view a code coverage report w/ missing lines, run
coverage report -m
Code Formatting
- To check file formatting, in top-level dir run
black --check . - To auto-reformat all files, remove the
--checkflag - To reformat an individual file, run
black <filename>
Package Build
To build the python package: $ poetry build
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/codeflare_sdk && pushd docs && rm -rf cluster job utils && mv codeflare_sdk/* . && rm -rf codeflare_sdk && popd && find docs -type f -name "*.html" -exec bash -c "echo '' >> {}" \;(it is possible to install pdoc using the following commandpoetry 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
10 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file codeflare_sdk-0.16.1.tar.gz.
File metadata
- Download URL: codeflare_sdk-0.16.1.tar.gz
- Upload date:
- Size: 30.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/5.0.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7e2341dcbbde4e064374046e141ba6ba68abec31be56fd8f692c42e260c0b659
|
|
| MD5 |
e374a42b04b11f2b0520a0944f85c8bc
|
|
| BLAKE2b-256 |
52c7c8858f42dc20c48617285ed5f87cdb5fcb9a25038e68a0f958d39f5d96a0
|
File details
Details for the file codeflare_sdk-0.16.1-py3-none-any.whl.
File metadata
- Download URL: codeflare_sdk-0.16.1-py3-none-any.whl
- Upload date:
- Size: 36.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/5.0.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ee79595fe8dca4cffc8e484732a463fb37d514cc01962d0178f98113ce8a80c5
|
|
| MD5 |
ae1a552265c660ccd279d97b31b49b6f
|
|
| BLAKE2b-256 |
f0dcd4cbde96932b731c9f5ed327172e380826e4f86864627a3491ebc126bc71
|
