From 018bdb4b3d2b33ca065a547e9a4a76fed1fadc09 Mon Sep 17 00:00:00 2001
From: Jeffrey Phillips Freeman <jeffrey.freeman@syncleus.com>
Date: Sat, 1 Feb 2020 12:23:08 +0100
Subject: [PATCH] Docs: Added Pypi deploy information to the contributing file.

---
 CONTRIBUTING.md | 23 +++++++++++++++++++++++
 README.md       | 12 ------------
 2 files changed, 23 insertions(+), 12 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b7eec5f..88afc19 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -12,6 +12,16 @@ Please note we have a code of conduct, please follow it in all your interactions
 
 ## Development
 
+### Testing
+
+In order to perform tests identical in nature to the integration tests we run then simply ensure you gave gitlab-runner installed then run the following command.
+
+```bash
+gitlab-runner exec docker test
+```
+
+Keep in mind this will run the tests on your local copy of the master branch so any changes not committed locally will be missed when testing.
+
 ### Commit Message Format
 
 All commits on the repository repository follow the
@@ -62,3 +72,16 @@ ISSUES CLOSED: #31
    versioning scheme we use is [Semantic Versioning](http://semver.org/).
 5. Your pull request will either be approved or feedback will be given on what needs to be
    fixed to get approval. We usually review and comment on Pull Requests within 48 hours.
+
+### Deploying to Pypi
+
+1. Ensure version number in setup.py is correct.
+2. Make sure any outstanding commits are pushed.
+3. If a dist/ folder exists delete it.
+4. Compile source distribution with `python setup.py sdist`
+5. Compile binary distribution with `python setup.py bdist_wheel`
+6. Check the packages for errors with `twine check dist/*`
+7. Upload to Pypi using `twine upload dist/`
+8. Create a tag for the current version such as `git tag -a v3.3,3 -m "version 3.3.3"`
+9. Push the tag
+10. Update the version in CHANGELOG.md and setup.py on master.
diff --git a/README.md b/README.md
index 420c964..d2552cc 100644
--- a/README.md
+++ b/README.md
@@ -105,15 +105,3 @@ This particular repository only represents the one component in a suite of libra
 * [Goblin](https://git.qoto.org/goblin-ogm/goblin) - The main library, the Goblin OGM
 * [Goblin Buildchain](https://git.qoto.org/goblin-ogm/goblin-buildchain) - Docker image containing all the needed tools to build and test Goblin.
 * [Python Gremlin Server](https://git.qoto.org/goblin-ogm/gremlin-server-python) - Vanilla Gremlin-server with Python Script Engine loaded, used for integration testing.
-
-## Developers
-
-### Testing
-
-In order to perform tests identical in nature to the integration tests we run then simply ensure you gave gitlab-runner installed then run the following command.
-
-```bash
-gitlab-runner exec docker test
-```
-
-Keep in mind this will run the tests on your local copy of the master branch so any changes not committed locally will be missed when testing.
-- 
GitLab