PyPI config and instruction

.github/workflows/yapf.yml

@@ -25,6 +25,7 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install yapf==0.32.0
+        pip install toml==0.10.2
     - name: Running yapf
       run: |
-        yapf --diff --style .style.yapf --recursive ./ --exclude 'sky/skylet/ray_patches/**' --exclude 'sky/skylet/providers/**'
+        yapf --diff --recursive ./ --exclude 'sky/skylet/ray_patches/**' --exclude 'sky/skylet/providers/**'

README.md

@@ -106,3 +106,23 @@ pip install tuna # Tuna for viz
 python3 -m cProfile -o sky.prof -m sky.cli status # Or some other command
 tuna sky.prof
 ```
+
+### Publish Release
+The package can be published to PyPi with the following steps ([official document](https://packaging.python.org/en/latest/tutorials/packaging-projects/)):
+1. Install prerequisites:
+```
+pip install --upgrade build
+pip install --upgrade twine
+```
+2. Increment the version number in [pyproject.toml](pyproject.toml)
+3. Build the package and upload it to PyPi test repository and check the installation:
+```
+cd $(git rev-parse --show-toplevel)
+python -m build
+twine upload --repository testpypi --skip-existing dist/*
+pip install --index-url https://test.pypi.org/simple/ --no-deps skypilot
+```
+4. If everything works well, upload the package to the main repository:
+```
+twine upload --skip-existing dist/*
+```

format.sh

@@ -38,7 +38,6 @@ tool_version_check "pylint" $PYLINT_VERSION "2.8.2"
 tool_version_check "pylint-quotes" $PYLINT_QUOTES_VERSION "0.2.3"
 
 YAPF_FLAGS=(
-    '--style' "$ROOT/.style.yapf"
     '--recursive'
     '--parallel'
 )

pyproject.toml

@@ -0,0 +1,27 @@
+[build-system]
+requires = ["setuptools>=58.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "skypilot"
+version = "0.0.0"
+authors = []
+description = "An intercloud broker above the clouds"
+readme = "README.md"
+license = { file="LICENSE" }
+requires-python = ">=3.6"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: Apache Software License",
+    "Operating System :: OS Independent",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: System :: Distributed Computing",
+]
+
+[project.urls]
+"Homepage" = "https://sky-proj-sky.readthedocs-hosted.com/en/latest/"
+"Bug Tracker" = "https://github.com/sky-proj/sky/issues"
+
+[tool.yapf]
+based_on_style = "google"
+allow_split_before_dict_value = false

requirements-dev.txt

@@ -3,6 +3,7 @@ yapf==0.32.0
 pylint==2.8.2
 # https://github.com/edaniszewski/pylint-quotes
 pylint-quotes==0.2.3
+toml==0.10.2
 
 # testing
 pytest