Skip to content

Commit 9736726

Browse files
committed
update release documentation for developers
1 parent 09ea97c commit 9736726

File tree

1 file changed

+28
-9
lines changed

1 file changed

+28
-9
lines changed

docs/source/development.rst

Lines changed: 28 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -95,34 +95,53 @@ See the ``travis-sphinx`` documentation and the file ``.travis.yml`` for details
9595
Release
9696
-------
9797

98+
Prerequisites
99+
^^^^^^^^^^^^^
100+
98101
See the PyPI documentation on generating a distribution archive, https://packaging.python.org/tutorials/packaging-projects/, for details.
99102

100-
Prerequisites: ``setuptools wheel twine``
103+
Required tools:
104+
105+
- ``setuptools``
106+
- ``wheel``
107+
- ``twine``
108+
109+
::
110+
111+
pip install --upgrade setuptools wheel twine
101112

102113
::
103114

104115
python3 setup.py sdist bdist_wheel
105116

106-
**Upload to test repository** and check everything is in order:
117+
Upload to test repository
118+
^^^^^^^^^^^^^^^^^^^^^^^^^
107119

108-
Check https://test.pypi.org/project/geoextent/
120+
First upload to the test repository and check everything is in order.
109121

110122
::
111123

124+
# upload with twine, make sure only one wheel is in dist/
112125
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
113126

114-
# TODO switch environment
127+
Check if the information on https://test.pypi.org/project/geoextent/ is correct.
128+
Then switch to a new Python environment, install geoextent from TestPyPI and try out package:
115129

116-
# TODO install from TestPyPI and try out package
130+
::
117131

118-
**Upload to PyPI:**
132+
pip install -i https://test.pypi.org/simple/ geoextent
119133

120-
Check https://pypi.org/project/geoextent/
134+
Upload to PyPI
135+
^^^^^^^^^^^^^^
121136

122137
::
123138

124139
twine upload dist/*
125140

126-
# TODO switch environment
127141

128-
# TODO install from TestPyPI and try out package
142+
Check if information on https://pypi.org/project/geoextent/ is all correct.
143+
Install the library from PyPI into a new Python environment and chech that everything works:
144+
145+
::
146+
147+
...

0 commit comments

Comments
 (0)