From 3ffa4165f01153f67102c835508bf6dd5a9a30bc Mon Sep 17 00:00:00 2001 From: Hemna Date: Mon, 14 Dec 2020 16:06:07 -0500 Subject: [PATCH] Updated README with development information --- README.rst | 42 ++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 40 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 43e758b..2cd34b8 100644 --- a/README.rst +++ b/README.rst @@ -151,6 +151,44 @@ LOCATION Message : ack7 Msg number : 0 - - AND... ping, fortune, time..... + + +Development +----------- + +While working aprsd, The workflow is as follows + +* Edit code, save file +* run tox -epep8 +* run tox -efmt +* run tox -p +* git commit + + +Release +------- + +To do release to pypi: + +* Tag release with + + git tag -v1.XX -m "New release" + +* push release tag up + + git push origin master --tags + +* Build dist and wheel + + python setup.py sdist bdist_wheel + +* Verify build is valid for pypi (need twine installed ) + + pip install twine + twine check dist/* + +* Once twine is happy, upload release to pypi + + twine upload dist/* +