@@ -34,7 +34,13 @@ git tag v0.5.0
3434git push origin v0.5.0
3535```
3636
37- ## 5. Create a Source Distribution
37+ ## 5. Clean the Build Environment
38+
39+ ```
40+ rm -rf build dist *.egg-info
41+ ```
42+
43+ ## 6. Create a Source Distribution
3844
3945```
4046python3 setup.py sdist
@@ -49,17 +55,17 @@ can be done by viewing the `stdout` of `python3 setup.py sdist`, by viewing
4955` framework_reproducibility.egg-info/SOURCES.txt ` , or by running ` tar -xf ` on the
5056source distribution file and examing the resuling directory structure.
5157
52- Note that ` framework-reproducibility.egg-info/SOURCES.txt ` is read in, modified,
53- and written back out by ` python3 setup.py sdist ` . Because of this, if any items
54- are to be excluded from the distribution (e.g. via ` MANIFEST.in ` or the
55- ` packages ` parameter of ` setup() ` in ` setup.py ` ) then
58+ Note that ` framework-reproducibility.egg-info/SOURCES.txt ` is read in (if it
59+ exists), modified, and written back out by ` python3 setup.py sdist ` . Because of
60+ this, if any items are to be excluded from the distribution (e.g. via
61+ ` MANIFEST.in ` or the ` packages ` parameter of ` setup() ` in ` setup.py ` ) then
5662` framework-reproducibility.egg-info ` must be deleted prior to running
5763` python3 setup.py sdist ` , otherwise the exluded items will remain.
5864
5965Note that to install the source distribution, the user will need to have ` pip `
6066installed, a new-enough version of ` setuptools ` and also ` wheel ` .
6167
62- ## 6 . Create a Universal Wheel
68+ ## 7 . Create a Universal Wheel
6369
6470```
6571python3 setup.py bdist_wheel
@@ -75,7 +81,7 @@ Note that `setup.cfg` specifies that wheels are universal by default.
7581[ Common Python Packaging Mistakes] [ 2 ] is a particularly useful resource that I
7682used in preparing the above two steps.
7783
78- ## 7 . Upload to PyPI
84+ ## 8 . Upload to PyPI
7985
8086Upload the source distribution and the universal wheel to the Python Package
8187Index (PyPI).
@@ -97,7 +103,7 @@ repository: https://test.pypi.org/legacy/
97103username: <username>
98104```
99105
100- ### 7a . Test PyPI Server
106+ ### 8a . Test PyPI Server
101107
102108
103109```
@@ -130,7 +136,7 @@ waiting for a few minutes can resolve issues where it seems that the latest
130136version is not yet available to install, even though you can see it should be
131137availble according to the web page for the distribution.
132138
133- ### 7b . Real PyPI Server
139+ ### 8b . Real PyPI Server
134140
135141```
136142twine upload --repository pypi dist/framework-reproducibility-<version>.tar.gz
@@ -147,7 +153,7 @@ venv/bin/pip install framework-reproducibility
147153rm -rf venv
148154```
149155
150- ## 8 . Create the GitHub Release
156+ ## 9 . Create the GitHub Release
151157
152158Finally, on GitHub, create a new release using the version tag created earlier
153159(e.g. ` v0.4.0 ` ).
0 commit comments