From 4cded5d3f876002b8e2d05e0db3630f44197ee6a Mon Sep 17 00:00:00 2001
From: Chris <audionautic@gmail.com>
Date: Sat, 8 Aug 2020 09:16:53 -0700
Subject: [PATCH] add internal pypi release docs

---
 docs/releases/pypi-distribution.md | 39 ++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 docs/releases/pypi-distribution.md

diff --git a/docs/releases/pypi-distribution.md b/docs/releases/pypi-distribution.md
new file mode 100644
index 0000000..67e7463
--- /dev/null
+++ b/docs/releases/pypi-distribution.md
@@ -0,0 +1,39 @@
+# Testing PyPi distribution before upload
+
+The 1.0.4 release was botched when uploading to PyPi as it pulled in the 1.0.3 artifacts sitting in my dev directory.  This meant that the 1.0.4 version was now clobbered on PyPi and could no longer be used. More care is needed when deploying. 
+
+
+### How to test locally before uploading
+
+1\. build the wheel
+
+```
+python pip_build_wheel.py
+``` 
+
+this will output the wheel to the `dist/` directory. 
+
+2/. Copy the file location. 
+
+Copy the absolute path to the .gz output file. It will look something like this:  
+
+```
+dist/Gooey-1.0.4.tar.gz
+```
+
+3\. In a different virtual environment, install the local wheel 
+
+```
+cd ~/projects/GooeyExamples
+virtualenv venv 
+source ./venv/Scripts/activate
+pip install /path/to/local/dist/Gooey-1.0.4.tar.gz
+``` 
+
+If everything installs OK, you're good to upload.
+
+```
+python pip_deploy.py
+```
+
+ 
\ No newline at end of file