Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PyPI config and instruction #999

Merged
merged 42 commits into from
Aug 8, 2022
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
ff7d619
pyproject.toml and instructions for publishing
Michaelvll Jul 20, 2022
094c3a3
older version of setuptools
Michaelvll Jul 20, 2022
af1cd49
Fix move yapf config into pyproject
Michaelvll Jul 21, 2022
8c3fcc3
Address comments
Michaelvll Jul 21, 2022
de4a918
Address comments
Michaelvll Jul 23, 2022
96c4236
Merge branch 'master' of github.com:concretevitamin/sky-experiments i…
Michaelvll Jul 23, 2022
f41bc25
Merge branch 'master' of github.com:concretevitamin/sky-experiments i…
Michaelvll Jul 28, 2022
a60d6fe
update pyproject.tom for open sourced
Michaelvll Jul 28, 2022
7fc5642
Remove authors
Michaelvll Jul 28, 2022
95095b6
Remove duplication of setup
Michaelvll Jul 28, 2022
38e951f
format
Michaelvll Jul 28, 2022
bf82aa3
Add wheel
Michaelvll Jul 28, 2022
a565f87
remove wheel
Michaelvll Jul 28, 2022
5974043
Fix readme path
Michaelvll Jul 28, 2022
2553731
format
Michaelvll Jul 28, 2022
5f501a3
Fix readme path for wheel
Michaelvll Jul 29, 2022
93a3139
Add comments
Michaelvll Jul 29, 2022
eb254df
Address comments
Michaelvll Jul 29, 2022
130c651
Fix
Michaelvll Jul 29, 2022
3b276f2
Merge branch 'master' of github.com:concretevitamin/sky-experiments i…
Michaelvll Jul 29, 2022
c5104bb
fix quote
Michaelvll Jul 29, 2022
fa0a6d0
Merge branch 'master' of github.com:concretevitamin/sky-experiments i…
Michaelvll Jul 30, 2022
bce6d3c
Add version option
Michaelvll Jul 30, 2022
26cb72e
format
Michaelvll Jul 30, 2022
05e4342
Merge branch 'master' of github.com:concretevitamin/sky-experiments i…
Michaelvll Aug 5, 2022
58abde4
Fix image path and footnote for pypi
Michaelvll Aug 5, 2022
ce9efef
format
Michaelvll Aug 5, 2022
38ac611
Merge branch 'master' of github.com:concretevitamin/sky-experiments i…
Michaelvll Aug 7, 2022
5f08e0a
Add env for all tests
Michaelvll Aug 7, 2022
1d3720d
fix pytest action
Michaelvll Aug 8, 2022
d9aab78
Merge branch 'master' of github.com:concretevitamin/sky-experiments i…
Michaelvll Aug 8, 2022
b1f00b2
Fix message
Michaelvll Aug 8, 2022
f3e928b
add print for smoke test
Michaelvll Aug 8, 2022
7ef123e
change version to rc1
Michaelvll Aug 8, 2022
6ccb49b
Fix wheel version
Michaelvll Aug 8, 2022
497bced
fix wheel
Michaelvll Aug 8, 2022
c7cd315
Add retry for azure
Michaelvll Aug 8, 2022
e1a6829
Fix smoke test
Michaelvll Aug 8, 2022
ef10e6b
increase version number
Michaelvll Aug 8, 2022
8fe5101
1.0.0-dev0
Michaelvll Aug 8, 2022
7b567f1
normalize version
Michaelvll Aug 8, 2022
5e18d11
Fix logging for retry
Michaelvll Aug 8, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/workflows/yapf.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ jobs:
run: |
python -m pip install --upgrade pip
pip install yapf==0.32.0
pip install toml==0.10.2
Michaelvll marked this conversation as resolved.
Show resolved Hide resolved
- 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/**'
concretevitamin marked this conversation as resolved.
Show resolved Hide resolved
3 changes: 0 additions & 3 deletions .style.yapf

This file was deleted.

15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,3 +106,18 @@ 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
Michaelvll marked this conversation as resolved.
Show resolved Hide resolved
The package can be published to PyPi with the following steps:
1. Install prerequisites:
```
pip install --upgrade build
pip install --upgrade twine
```
2. Increase the version number in [pyproject.toml](pyproject.toml)
Michaelvll marked this conversation as resolved.
Show resolved Hide resolved
3. Build the package and upload it to Pypi:
```
cd $(git rev-parse --show-toplevel)
python -m build
twine upload dist/*
```
1 change: 0 additions & 1 deletion format.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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'
)
Expand Down
25 changes: 25 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
[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 cloud"
Michaelvll marked this conversation as resolved.
Show resolved Hide resolved
readme = "README.md"
license = { file="LICENSE" }
requires-python = ">=3.6"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we require < 3.10 explicitly in our docs, is there some way we can specify it here?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thinking more about it, this article provides very good arguments for not capping the version. Maybe we can let it be unless we have a strong dependency on <3.10?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahh, good discussion! I think the only dependency for <3.10 is our current ray==1.10.0. The problem should be fixed by #969.

classifiers = [
"Programming Language :: Python :: 3",
"License :: OSI Approved :: Apache Software License",
"Operating System :: OS Independent",
Michaelvll marked this conversation as resolved.
Show resolved Hide resolved
]

[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
Michaelvll marked this conversation as resolved.
Show resolved Hide resolved