Skip to content

PyPI Release Notes

Notes and information on how to do the PyPI release for the SageMaker project. For full details on packaging you can reference this page Packaging

The following instructions should work, but things change :)

Package Requirements

  • pip install tox
  • pip install --upgrade wheel build twine

Setup pypirc

The easiest thing to do is setup a \~/.pypirc file with the following contents

[distutils]
index-servers =
  pypi
  testpypi

[pypi]
username = __token__
password = pypi-AgEIcH...

[testpypi]
username = __token__
password = pypi-AgENdG...

Tox Background

Tox will install the SageMaker Sandbox package into a blank virtualenv and then execute all the tests against the newly installed package. So if everything goes okay, you know the pypi package installed fine and the tests (which puls from the installed workbench package) also ran okay.

Make sure ALL tests pass

$ cd workbench
$ tox

If ALL the test above pass...

Clean any previous distribution files

make clean

Tag the New Version

git tag v0.1.8 (or whatever)
git push --tags

Create the TEST PyPI Release

python -m build
twine upload dist/* -r testpypi

Install the TEST PyPI Release

pip install --index-url https://test.pypi.org/simple workbench

Create the REAL PyPI Release

twine upload dist/* -r pypi

Push any possible changes to Github

git push