Add deploy script

Author: 31ch

Jenkinsfile

@@ -105,9 +105,11 @@ pipeline {
             environment {
                 TWINE_REPOSITORY_URL = 'http://gitea.lan:3000/api/packages/root/pypi'
                 TWINE_CREDENTIALS = credentials('gitea')
+                TWINE_USERNAME = TWINE_CREDENTIALS_USR
+                TWINE_PASSWORD = TWINE_CREDENTIALS_PSW
             }
             steps {
-                sh 'twine upload --user $TWINE_CREDENTIALS_USR --password $TWINE_CREDENTIALS_PSW dist/*'
+                sh './tools/deploy-package.sh'
             }
         }
     }

Jenkinsfile.groovy

@@ -89,7 +89,7 @@ node {
                         passwordVariable: 'TWINE_PASSWORD'
                     )
                 ]) {
-                    sh 'twine upload dist/*'
+                    sh './tools/deploy-package.sh'
                 }
             }
         }

README.md

@@ -36,7 +36,9 @@ The Python package is based on the following toolchain:
 ├── dist    Reserved folder for build artifacts
 ├── docs    Sphinx documentation
 ├── src     Python package source code
-└── tests   Python tests
+├── tests   Python tests
+└── tools   Scripts
+
 ```
 
 ## Build, test and deploy instructions
@@ -52,37 +54,53 @@ Note: the Python virtual environment can be removed using `pipenv --rm`.
 
 **IMPORTANT:** all of the following commands have to be executed within the Python virtual environment!
 
-Build the Sphinx documentation:
+### Build documentation
+
+Build the Sphinx documentation: `./tools/build-docs.sh`
 
 ```bash
 pip install -e .  # package installation is required for Git version
 cd docs
 make html
 ```
 
-Build the Python package:
+### Build Python package
+
+Build the Python package: `./tools/build-package.sh`
 
 ```bash
 python -m build --wheel
 ```
 
-Execute static code analysis:
+### Run Python linters
+
+Run static code analysis: `./tools/lint-package.sh`
 
 ```bash
-flake8 src/python_training_project --format=pylint > flake8.log
-pylint src/python_training_project --msg-template="{path}:{line}: [{msg_id}, {obj}] {msg} ({symbol})" > pylint.log
-mypy src/python_training_project > mypy.log
+mkdir -p build
+flake8 src/python_training_project --format=pylint > build/flake8.txt
+pylint src/python_training_project --msg-template="{path}:{line}: [{msg_id}, {obj}] {msg} ({symbol})" > build/pylint.txt
+mypy src/python_training_project > build/mypy.txt
 ```
 
-Execute Python tests:
+### Run Python tests
+
+Run Python tests: `./tools/test-package.sh`
 
 ```bash
 pip install -e .  # package installation is required for path resolution
+mkdir -p build
 pytest
 ```
 
-Deploy the Python package:
+### Deploy Python package
+
+Deploy the Python package: `./tools/deploy-package.sh`
 
 ```bash
-twine upload --repository-url REPOSITORY_URL --username USERNAME --password PASSWORD dist/*
+# Make sure to set the following environment variables
+# TWINE_REPOSITORY_URL
+# TWINE_USERNAME
+# TWINE_PASSWORD
+twine upload dist/*
 ```

tools/deploy-package.sh

@@ -0,0 +1,11 @@
+#!/bin/bash -e
+
+# Get Git root directory
+REPO_ROOT=$(git rev-parse --show-toplevel)
+
+pushd "${REPO_ROOT}" 2>&1 > /dev/null
+
+echo "Deploying package..."
+twine upload dist/*
+
+popd 2>&1 > /dev/null