diff --git a/README.md b/README.md index 1ac37ce7e..e2202aaf6 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,20 @@ # 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. + +Documentation site coming soon, link will be provided here + +## Installation + +Can be installed via `pip`: `pip install codeflare-sdk` + +## Development + +For testing, make sure to have installed: + - `pytest` + - The remaining dependencies located in `requirements.txt` +NOTE: Self-contained unit/functional tests coming soon, will live in `tests` folder + To build the python package: - If poetry is not installed: `pip3 install poetry` - `poetry build` - -To publish: - - `poetry publish` diff --git a/pyproject.toml b/pyproject.toml index fee246c85..a1d6c1e4f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -14,8 +14,8 @@ authors = [ readme = 'README.md' -repository = "https://github.com/openshift-psap/codeflare-sdk" -homepage = "https://github.com/openshift-psap/codeflare-sdk" +repository = "https://github.com/project-codeflare/codeflare-sdk" +homepage = "https://github.com/project-codeflare/codeflare-sdk" keywords = ['codeflare', 'python', 'sdk', 'client', 'batch', 'scale'] diff --git a/tests/test_clusters.py b/tests/test_clusters.py index c40b16c2b..d4ffa6d7b 100644 --- a/tests/test_clusters.py +++ b/tests/test_clusters.py @@ -17,6 +17,8 @@ import time +# FIXME - These tests currently assume OC logged in, and not self-contained unit/funcitonal tests + def test_cluster_up(): cluster = Cluster(ClusterConfiguration(name='raycluster-autoscaler')) cluster.up()