Updated README for Opening Repo

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`

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']
 

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