Write new Python SDK version processes

fharper commented 3 years ago

Write new Python SDK version processes. Examples: tag the new version, update the releases notes, push on PyPI...

fharper commented 3 years ago

GitHub Release

We follow the semantic versioning standard.

Update the version number in setup.py
Update CHANGELOG.md by adding details about the new version
Commit those changes with the message chg: 🔖 prepare vX.X.X

Draft a new release

Create a new tag with the new version number vX.X.X
Set the release title to the same name
Copy your release notes CHANGELOG.md
Publish the release

Next step is to deploy the package on PyPI.

PyPI

First time setup

You need to add the configuration to be able to publish from your computer, but before that, ensure you have the latest pip version, the building and publishing tools installed:

python -m pip install --upgrade pip
python -m pip install --upgrade build
python -m pip install --upgrade twine

In your home directory, create .pypirc file with this content by replacing <TOKEN> with the proper token information for both sites:

[distutils]
index-servers =
    mindee
    mindee-test

[mindee]
repository = https://upload.pypi.org/legacy/
username = __token__
password = <TOKEN>

[mindee-test]
repository = https://test.pypi.org/legacy/
username = __token__
password = <TOKEN>

note that __token__ in username need to stay exactly the same, and not modified with token ID.
Remove previous build you may have with rm dist/*
Build the source distribution python -m build --sdist
Build the wheel python -m build --wheel
Upload the package on TestPyPI first python -m twine upload --repository mindee-test dist/*
Check that everything is fine
Upload the package on PyPi python -m twine upload --repository mindee dist/*

fharper commented 3 years ago

PR sent https://github.com/mindee/devrel/pull/69

fharper commented 3 years ago

done https://github.com/mindee/devrel/blob/main/SDKs/SDKs.md#python-sdk-new-release-process

mindee / devrel