diff --git a/python/README.md b/python/README.md index 7b0d89f0e..8f34e8765 100644 --- a/python/README.md +++ b/python/README.md @@ -1,2 +1,34 @@ # Python Bindings for Vulkan Kompute +## Publishing to pypi + +Build source distribution: + +``` +python setup.py sdist bdist_wheel +``` + +Push to test pypi registry: + +``` +python -m twine upload --repository testpypi dist/* +``` + +Install from test pypi: + +``` +python -m pip install --index-url https://test.pypi.org/simple/ --no-deps kp +``` + +Run tests in python/test directory: + +``` +python -m pytest +``` + +Push to official pypi registry: + +``` +python -m twine upload dist/* +``` +