From 9736726b25d046db6efcb8b76ccd54ef1f7ef36d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20N=C3=BCst?= Date: Wed, 25 Mar 2020 16:58:27 +0100 Subject: [PATCH] update release documentation for developers --- docs/source/development.rst | 37 ++++++++++++++++++++++++++++--------- 1 file changed, 28 insertions(+), 9 deletions(-) diff --git a/docs/source/development.rst b/docs/source/development.rst index 73bc184..d401861 100644 --- a/docs/source/development.rst +++ b/docs/source/development.rst @@ -95,34 +95,53 @@ See the ``travis-sphinx`` documentation and the file ``.travis.yml`` for details Release ------- +Prerequisites +^^^^^^^^^^^^^ + See the PyPI documentation on generating a distribution archive, https://packaging.python.org/tutorials/packaging-projects/, for details. -Prerequisites: ``setuptools wheel twine`` +Required tools: + +- ``setuptools`` +- ``wheel`` +- ``twine`` + +:: + + pip install --upgrade setuptools wheel twine :: python3 setup.py sdist bdist_wheel -**Upload to test repository** and check everything is in order: +Upload to test repository +^^^^^^^^^^^^^^^^^^^^^^^^^ -Check https://test.pypi.org/project/geoextent/ +First upload to the test repository and check everything is in order. :: + # upload with twine, make sure only one wheel is in dist/ twine upload --repository-url https://test.pypi.org/legacy/ dist/* - # TODO switch environment +Check if the information on https://test.pypi.org/project/geoextent/ is correct. +Then switch to a new Python environment, install geoextent from TestPyPI and try out package: - # TODO install from TestPyPI and try out package +:: -**Upload to PyPI:** + pip install -i https://test.pypi.org/simple/ geoextent -Check https://pypi.org/project/geoextent/ +Upload to PyPI +^^^^^^^^^^^^^^ :: twine upload dist/* - # TODO switch environment - # TODO install from TestPyPI and try out package +Check if information on https://pypi.org/project/geoextent/ is all correct. +Install the library from PyPI into a new Python environment and chech that everything works: + +:: + + ...