Cleaner release process

Author: pylessard

doc/source/conf.py

@@ -14,12 +14,14 @@
 
 import sys
 import os
+from os.path import abspath, join, dirname, normpath
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 
-sys.path.insert(0, os.path.abspath('../..'))
+sys.path.insert(0, normpath(abspath(join(dirname(__file__), '..', '..'))))
+import udsoncan
 
 # -- General configuration ------------------------------------------------
 
@@ -60,9 +62,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = u'1.23'
+version = '.'.join(udsoncan.__version__.split('.')[0:2])
 # The full version, including alpha/beta/rc tags.
-release = version
+release = udsoncan.__version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

scripts/release.sh

@@ -0,0 +1,42 @@
+#!/bin/bash
+set -eEuo pipefail
+PROJECT_ROOT="$( cd "$( dirname "${BASH_SOURCE[0]}" )"/.. >/dev/null 2>&1 && pwd -P )"
+cd "$PROJECT_ROOT"
+
+RED='\033[0;31m'; CYAN='\033[0;36m'; YELLOW='\033[1;33m'; NC='\033[0m' 
+
+info()  { >&2 echo -e "$CYAN[Info]$NC $1";}
+warn()  { >&2 echo -e "$YELLOW[Warning]$NC $1";}
+error() { >&2 echo -e "$RED[Error]$NC $1"; }
+fatal() { >&2 echo -e "$RED[Fatal]$NC $1"; exit ${2:-1}; }
+
+trap 'fatal "Exited with status $? at line $LINENO"' ERR 
+
+[ -z ${1:+x} ] && fatal "Missing version argument"
+
+version=$1
+
+git_diff=$(git diff --shortstat)
+git_diff_cached=$(git diff --shortstat --cached)
+
+[ -z $git_diff ] || fatal "Uncomitted changes on repo"
+[ -z $git_diff_cached ] || fatal "Staging changes on repo"
+
+tag=$( { git tag -l --points-at HEAD || true; } | { grep $version || true; })
+code_version=$(cat udsoncan/__init__.py | grep __version__  | sed -r "s/__version__[[:space:]]*=[[:space:]]*'([^']+)'/\1/")
+
+[ "$version" != "$tag" ] && fatal "Tag of HEAD does not match given version. Expected '$version'"
+[ "$version" != "v$code_version" ] && fatal "Code version does not match given version : 'v$code_version' vs '$version'"
+
+rm -rf build dist *.egg-info
+python3 -m build
+
+read -p "Everything seems alright. Upload? "
+
+proceed=0
+ 
+[ "${REPLY,,}" == "yes" ] && proceed=1
+[ "${REPLY,,}" == "y" ] && proceed=1
+
+[ $proceed -ne 1 ] && { info "Not uploading"; exit; }
+python3 -m twine upload dist/*

setup.py

@@ -1,9 +1,13 @@
 from setuptools import setup, find_packages
 from codecs import open
 from os import path
+import sys
 
 here = path.abspath(path.dirname(__file__))
 
+sys.path.insert(0, here)
+import udsoncan
+
 with open(path.join(here, 'README.rst'), encoding='utf-8') as f:
     long_description = f.read()
 
@@ -18,14 +22,14 @@
         'test': ['mypy', 'coverage'],
         'dev': ['mypy', 'ipdb', 'autopep8', 'coverage']
     },
-    version='1.23.0',
+    version=udsoncan.__version__,
     description='Implementation of the Unified Diagnostic Service (UDS) protocol (ISO-14229) used in the automotive industry.',
     long_description=long_description,
     author='Pier-Yves Lessard',
     author_email='[email protected]',
     license='MIT',
     url='https://github.com/pylessard/python-udsoncan',
-    download_url='https://github.com/pylessard/python-udsoncan/archive/v1.23.0.tar.gz',
+    download_url=f'https://github.com/pylessard/python-udsoncan/archive/v{udsoncan.__version__}.tar.gz',
     keywords=['uds', '14229', 'iso-14229', 'diagnostic', 'automotive'],
     python_requires='>=3.7',
     classifiers=[

udsoncan/__init__.py

@@ -21,6 +21,10 @@
 from udsoncan.common.Units import *
 from udsoncan.typing import *
 
+__version__ = '1.23.1'
+__license__ = 'MIT'
+__author__ = 'Pier-Yves Lessard'
+
 latest_standard = 2020
 __default_log_config_file = path.join(path.dirname(path.abspath(__file__)), 'logging.conf')