Add releasing docs for python artifacts (jobclient, sidecar, cli)#2066
Add releasing docs for python artifacts (jobclient, sidecar, cli)#2066scrosby wants to merge 3 commits intotwosigma:masterfrom
Conversation
| ``` | ||
| Then, in a separate virtualenv for testing: | ||
| ```bash | ||
| pip3 install --index-url https://test.pypi.org/simple/ --no-deps cook-executor==$VERSION |
There was a problem hiding this comment.
(this is a few places in this file, btw)
| ``` | ||
| Then, in a separate virtualenv for testing: | ||
| ```bash | ||
| pip3 install --index-url https://test.pypi.org/simple/ --no-deps cook-executor==$VERSION |
There was a problem hiding this comment.
(this is a few places in this file, btw)
| Then, in a separate virtualenv for testing: | ||
| ```bash | ||
| pip3 install --index-url https://test.pypi.org/simple/ --no-deps cook-executor==$VERSION | ||
| pip3 install # install any other required dependencies from the main pypi repo |
There was a problem hiding this comment.
This part was confusing to me. I ended up installing cook-client
pip3 install cook-client
and then using the full path to the cs in my virtual env. Is that what you meant?
| @@ -0,0 +1,41 @@ | |||
| Releasing Cook Executor | |||
There was a problem hiding this comment.
This file still says executor in some places
| ``` | ||
| Then, in a separate virtualenv for testing: | ||
| ```bash | ||
| pip3 install --index-url https://test.pypi.org/simple/ --no-deps cook-executor==$VERSION |
There was a problem hiding this comment.
cook-sidecar, not cook-executor
| Since PyPI does not allow modifying releases, it can be useful to test a release using their test instance. | ||
| ```bash | ||
| rm -rf dist/* | ||
| python3 setup.py sdist bdist_wheel |
There was a problem hiding this comment.
Not sure if this is worth mentioning or if this is just some Python distribution basics that I missed, but bdist_wheel isn‘t available unless you pip install wheel
| Releasing Cook Executor | ||
| ======================= | ||
|
|
||
| Cook Sidecar is released on [PyPI](https://pypi.org/project/cook-executor/) |
There was a problem hiding this comment.
cook-sidecar, not cook-executor
| ------------- | ||
| Ensure you can build the sidecar following the instructions in README.md | ||
|
|
||
| Install `twine`: |
There was a problem hiding this comment.
Also install wheel to be able to bdist_wheel
| Releasing Cook Executor | ||
| ======================= | ||
|
|
||
| Cook's Jobclient API is released on [PyPI](https://pypi.org/project/cook-executor/) |
There was a problem hiding this comment.
cook-client-api, not cook-executor
| ------------- | ||
| Ensure you can build the cli following the instructions in README.md | ||
|
|
||
| Install `twine`: |
There was a problem hiding this comment.
Also install wheel to be able to bdist_wheel
| ------------- | ||
| Ensure you can build it following the instructions in README.md | ||
|
|
||
| Install `twine`: |
There was a problem hiding this comment.
Also install wheel to be able to bdist_wheel
scrosby
force-pushed
the
outgoing/python-release-docs
branch
from
12affa1 to
1f3330f
Compare
3 participants
Changes proposed in this PR
Why are we making these changes?
Make it easier to know how to release Cook.