release 0.5.1

.git-blame-ignore-revs

@@ -0,0 +1,4 @@
+# First black run on all code
+7cd00161dece9ce2a1d9387bd48e569f59f851bf
+# Second black run
+d3c260e9fb64fab2c4b9cb7d58e05f7d8ca0424e

.prospector.yaml

@@ -21,6 +21,13 @@ pylint:
     max-attributes: 12
     max-module-lines: 3000
 
+pycodestyle:
+  disable:
+    - E203
+    - W503
+  enable:
+    - W504
+
 pyroma:
   run: true
 

Makefile

@@ -0,0 +1,33 @@
+# Minimal Makefile for automating recurring tasks during development
+#
+# Copyright (c) 2023, Till Biskup
+# 2023-12-06
+
+.PHONY: docs tests help
+.DEFAULT_GOAL := help
+
+help:
+	@echo "This makefile automates different recurring tasks"
+	@echo ""
+	@echo "The following targets are available:"
+	@echo ""
+	@echo "docs  - create documentation using Sphinx"
+	@echo "tests - run unittests"
+	@echo "check - check code using prospector"
+	@echo "black - format code using Black"
+
+docs:
+	@echo "Create documentation using Sphinx"
+	$(MAKE) -C docs html
+
+tests:
+	@echo "Run unittests"
+	cd tests/ && python -m unittest discover -s . -t .
+
+check:
+	@echo "Check code using prospector... this may take a while"
+	prospector
+
+black:
+	@echo "Automatically format code using Black"
+	black -l 78 . --extend-exclude templates

README.rst

@@ -38,7 +38,8 @@ What is even better: Actual data processing and analysis **no longer requires pr
             - first-dataset.pdf
             - second-dataset.pdf
 
-For more general information on the cwepr package and for how to use it, see its `documentation <https://doc.cwepr.de/>`_.
+For more general information on the cwepr package and for how to use it, see
+its `documentation <https://docs.cwepr.de/>`_.
 
 
 Features

VERSION

@@ -1 +1 @@
-0.5.0
+0.5.1

bin/formatPythonCode.sh

@@ -0,0 +1,43 @@
+#!/usr/bin/env bash
+#
+# Autoformat Python files currently in git staging area.
+#
+# Intended for using in pre-commit hook
+#
+# Formatter, formatter options and exclude pattern can be set.
+#
+# Note that due to calling the formatter explicitly for files, exclude patterns
+# via formatter options are likely to not work. Hence the list of files to be
+# reformatted needs to be filtered beforehand.
+#
+# Existence of the formatter is checked, and if it is not present,
+# the script silently exits.
+#
+# Only Python files in the staging area are reformatted and afterwards
+# re-added to the staging area.
+#
+# Copyright (c) 2023, Till Biskup
+# 2023-12-06
+
+FORMATTER="black"
+FORMATTER_OPTIONS="-l 78"
+EXCLUDE_PATTERN="templates"
+
+if ! command -v $FORMATTER &> /dev/null
+then
+  exit
+fi
+
+if \[ -n "$EXCLUDE_PATTERN" \];
+then
+  CHANGED_FILES=$(git diff --cached --name-only --diff-filter=ACMR -- '*.py' |  grep -v $EXCLUDE_PATTERN)
+else
+  CHANGED_FILES=$(git diff --cached --name-only --diff-filter=ACMR -- '*.py')
+fi
+
+for file in $CHANGED_FILES
+do
+  echo "Reformat '$file' using '$FORMATTER $FORMATTER_OPTIONS'"
+  $FORMATTER $FORMATTER_OPTIONS "$file"
+  git add "$file"
+done